Prerequisites:
- Helm installed locally
- Write access to the charts repository
- Familiarity with the existing chart layout and release workflows
Initialize Helm Chart
Use Helm to create a new chart structure:Or manually create the required files:
Chart.yaml- Chart metadatavalues.yaml- Default configuration valuestemplates/- Kubernetes manifest templates
Verify that the chart directory contains the files your repository workflows expect before you continue.
Create Chart README
Create a
README.md in your chart directory with:- Chart description
- Prerequisites
- Installation instructions
- Configuration options
- Examples
Update Repository Index
Add your chart to the repository index. This is typically done through CI/CD or manually:
Update GitHub Workflow
Update the chart matrix in all workflows so the new chart builds and tests:
.github/workflows/ci.yml: add your chart tostrategy.matrix.chartfor CI validation.github/workflows/release.yml: add your chart for release automation
Follow Chart Standards
Before you open a pull request, make sure the chart follows these standards:
- Use semantic versioning
- Include proper labels and annotations
- Document all values in
values.yaml - Include example configurations
- Follow Kubernetes naming conventions
Verify that the chart builds and that the repository workflows include it in CI and release automation.
Resources
For detailed instructions and examples, see the charts repository README.Refer to the Helm documentation for comprehensive chart development guidelines.