Skip to content

Commit 034c579

Browse files
chore(charts): correct stale release guidance in comments and charts/README
The artifacthub.io/changes comments told the reader to keep the list in step with the changelog's [Unreleased] section, which no longer exists under Release Please. They now state the real hazard: Release Please bumps `version:` but does not touch this annotation, so it silently ends up describing the previous release unless it is updated in the release PR. charts/README.md pointed at release.sh as recommended; it now points at RELEASE.md and notes that release.sh follows the older convention. Deliberately `chore:` so it stays hidden and opens no release PR — comments and a directory README are not user-facing chart changes.
1 parent 08587af commit 034c579

4 files changed

Lines changed: 19 additions & 52 deletions

File tree

charts/README.md

Lines changed: 12 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -8,61 +8,24 @@ This directory contains the maintained Helm charts published from this repositor
88

99
## Releasing Charts
1010

11-
Charts are released from Git tags via GitHub Actions.
11+
**See [`RELEASE.md`](../RELEASE.md) for the full process.** In short: charts are released by
12+
**Release Please**, which opens one release PR per chart on every push to `master`. Merging that PR
13+
tags, releases, and publishes the chart. You do not edit versions or changelogs by hand.
1214

13-
Preferred distribution is the GitHub Pages Helm repository:
15+
Which chart a commit releases is decided by the **file paths it touches**, not by the commit scope,
16+
so keep a commit to one chart where you can.
1417

15-
```bash
16-
helm repo add ontoserver https://aehrc.github.io/ontoserver-deploy
17-
```
18-
19-
Release tags must match the workflow triggers in `.github/workflows/release.yml`:
20-
21-
- `ontoserver-vX.Y.Z`
22-
- `ontoserver-extras-vX.Y.Z`
23-
- `ontoserver-indexer-vX.Y.Z`
24-
25-
Pushing one of those tags triggers the chart release workflow, which:
26-
27-
- publishes the chart to the GitHub Pages Helm repository via `chart-releaser-action`
28-
- updates `artifacthub-repo.yml` on the `gh-pages` branch
29-
- pushes the packaged chart to `ghcr.io/aehrc` as a secondary OCI artifact
30-
31-
### Using release.sh (recommended)
32-
33-
Use `release.sh` to automate the full release cycle — tagging the current version, triggering the release workflow, then bumping `Chart.yaml` for the next cycle:
34-
35-
```bash
36-
# Interactive — tags current version, prompts for next (default: minor bump)
37-
./charts/release.sh ontoserver
38-
39-
# Fully automated minor bump, no prompt
40-
./charts/release.sh ontoserver --auto-increment
41-
42-
# Patch or major bump
43-
./charts/release.sh ontoserver --patch
44-
./charts/release.sh ontoserver --major
45-
46-
# Set next version explicitly
47-
./charts/release.sh ontoserver --next-version 1.0.0
48-
49-
# Preview without making changes
50-
./charts/release.sh ontoserver --dry-run
51-
```
52-
53-
Replace `ontoserver` with `ontoserver-extras` or `ontoserver-indexer` for the other charts.
54-
55-
### Manual release (alternative)
18+
Distribution:
5619

5720
```bash
58-
git tag ontoserver-v0.1.0
59-
git push origin ontoserver-v0.1.0
21+
helm repo add ontoserver https://aehrc.github.io/ontoserver-deploy
22+
helm install my-ontoserver ontoserver/ontoserver -f your-values.yaml
6023
```
6124

62-
After the first release, confirm:
63-
64-
- GitHub Pages is enabled for the `gh-pages` branch
65-
- the new chart version appears in the Helm repo index
25+
`release.sh` and the tag-triggered `.github/workflows/release.yml` are retained for manual releases
26+
and recovery only — note that `release.sh` still follows the **older** convention where `Chart.yaml`
27+
holds the in-development version, so using it leaves `.release-please-manifest.json` out of step.
28+
`RELEASE.md` covers both, plus recovery steps.
6629
- the corresponding `ghcr.io` package visibility is set as intended
6730

6831
## Releasing Varnish Exporter

charts/ontoserver-extras/Chart.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ maintainers:
2020
annotations:
2121
artifacthub.io/category: integration-delivery
2222
artifacthub.io/license: Apache-2.0
23-
# Describes the version in `version:` above. Keep in step with the changelog's [Unreleased].
23+
# Describes the version in `version:` above — the last released version. Release Please bumps
24+
# `version:` but does NOT touch this list; update it in the release PR before merging.
2425
artifacthub.io/changes: |
2526
- kind: fixed
2627
description: Varnish now restarts when the VCL changes (checksum/config pod annotation)

charts/ontoserver-indexer/Chart.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ maintainers:
2020
annotations:
2121
artifacthub.io/category: integration-delivery
2222
artifacthub.io/license: Apache-2.0
23+
# Describes the version in `version:` above — the last released version. Release Please bumps
24+
# `version:` but does NOT touch this list; update it in the release PR before merging.
2325
artifacthub.io/changes: |
2426
- kind: added
2527
description: resources.heapGb to size the JVM heap independently of the container memory limit

charts/ontoserver/Chart.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@ maintainers:
1919
annotations:
2020
artifacthub.io/category: integration-delivery
2121
artifacthub.io/license: Apache-2.0
22-
# Describes the version in `version:` above, i.e. the release this Chart.yaml will be tagged as.
23-
# Keep in step with the changelog's [Unreleased] section.
22+
# Describes the version in `version:` above — which is the LAST RELEASED version under Release
23+
# Please, not an in-development one. Release Please bumps `version:` but does NOT touch this list,
24+
# so update it in the release PR before merging or it will silently describe the previous release.
2425
artifacthub.io/changes: |
2526
- kind: added
2627
description: Opt-in pod and container securityContext values (unset by default, so upgrades roll no pods)

0 commit comments

Comments
 (0)