daniel-ramon-gallardo/helm-rule icon
public
Published on 5/5/2025
Helm Rule

A helm rule

Rules
## Build & Development Commands
- Use `helm lint ./chart` to validate the syntax and structure of the Helm chart.  
- Use `helm template ./chart` to render the templates locally and debug output.  
- Package charts with `helm package ./chart` and store them in the `./dist` folder.  
- Use `helm install <release-name> ./chart --dry-run --debug` for a safe test deployment.  

## Testing Guidelines
- Ensure that Helm templates render correctly for multiple values files using `helm template -f values.yaml`.  
- Add unit tests for templates using a tool like [helm-unittest](https://github.com/helm-unittest/helm-unittest).  
- Validate schema with JSON Schema via `values.schema.json` and test with representative `values.yaml` files.  

## Code Style & Guidelines 
- Follow Helm chart best practices from the [Helm Chart Best Practices Guide](https://helm.sh/docs/chart_best_practices/).  
- Keep template files clean and modular; use helper templates (`_helpers.tpl`) for repeated logic.  
- Use consistent naming conventions for resources: `<release-name>-<component>`.  
- Avoid hardcoded values; everything configurable should be placed in `values.yaml`.  

## Documentation Guidelines 
- Document all configurable values in `values.yaml` with comments explaining each key.  
- Keep a `README.md` at the chart root explaining installation steps, dependencies, and usage examples.  
- Include versioning, change history, and Helm Chart metadata in `Chart.yaml`.