You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASING.md
+4-19Lines changed: 4 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,24 +11,9 @@ Releases are automated via [release-please](https://github.com/googleapis/releas
11
11
- Updates `CHANGES.md` with the changelog for the new version
12
12
3. When that PR is merged, release-please creates a GitHub release tagged `X.Y.Z`, which triggers the PyPI publish workflow.
13
13
14
-
## Helm chart releases
14
+
## Helm chart version
15
15
16
-
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`.
17
-
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).
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
-
```
16
+
The Helm chart `version:` in `deployment/k8s/charts/Chart.yaml` is **not** managed by release-please. The chart version is bumped manually when chart structure changes (templates, values, dependencies). The `appVersion` field (the titiler app version the chart deploys) is still updated automatically alongside every Python release, and as part of this process, the chart version can be manually updated by bumping the version in a simple commit in the release please PR.
32
17
33
18
## Commit message convention
34
19
@@ -40,6 +25,6 @@ Version bumps follow [semantic versioning](https://semver.org/) based on commit
40
25
|`feat:`| minor |
41
26
|`feat!:` or `BREAKING CHANGE:` footer | major |
42
27
43
-
## No manual steps required
28
+
## (Almost) No manual steps required
44
29
45
-
All version files are updated automatically. Do not manually edit version strings in `pyproject.toml`, `Chart.yaml`, or `__init__.py` files — release-please owns those.
30
+
All version files are updated automatically. Do not manually edit version strings in `pyproject.toml`, `Chart.yaml` (`appVersion`), or `__init__.py` files — release-please owns those. The `version:` field in `Chart.yaml` is the only exception: bump it manually when chart structure changes warrant a new chart release.
0 commit comments