Skip to content

Commit 3caa577

Browse files
committed
chore: add section on helm versioning
1 parent e5cbfd5 commit 3caa577

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

RELEASING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,21 @@ Releases are automated via [release-please](https://github.com/googleapis/releas
1515

1616
The Helm chart (`deployment/k8s/charts/`) is versioned independently from the Python package. release-please opens a separate helm release PR when commits touch files under `deployment/k8s/charts/`. That PR bumps `version:` in `Chart.yaml` and updates `deployment/k8s/charts/CHANGELOG.md`. The resulting GitHub release is tagged `helm-vX.Y.Z`.
1717

18+
**Commit messages matter for chart releases.** A chart version bump only happens when a commit both:
19+
- touches at least one file under `deployment/k8s/charts/`, **and**
20+
- uses a bump-triggering type (`fix:`, `feat:`, or a breaking change)
21+
22+
`chore:`, `ci:`, `docs:`, and other non-bumping types that touch chart files are valid conventional commits but will **not** produce a chart release. Use them for housekeeping that doesn't warrant a version bump (e.g. updating CI config, fixing a comment).
23+
24+
Examples:
25+
26+
```
27+
fix(helm): correct resource limit defaults → patch bump
28+
feat(helm): add support for extra environment vars → minor bump
29+
feat(helm)!: rename required value X to Y → major bump
30+
chore(helm): update maintainer list → no bump
31+
```
32+
1833
## Commit message convention
1934

2035
Version bumps follow [semantic versioning](https://semver.org/) based on commit type:

0 commit comments

Comments
 (0)