Skip to content

Commit 5de6311

Browse files
Add chart release instructions
1 parent ba72715 commit 5de6311

2 files changed

Lines changed: 60 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ See each chart's README for full configuration reference:
4545
- [`charts/ontoserver/README.md`](charts/ontoserver/README.md) — platform-specific examples (AKS, EKS, local k3d)
4646
- [`charts/ontoserver-extras/README.md`](charts/ontoserver-extras/README.md)
4747
- [`charts/ontoserver-indexer/README.md`](charts/ontoserver-indexer/README.md) — SNOMED CT and LOINC indexing examples
48+
- [`charts/README.md`](charts/README.md) — chart release and publishing instructions
49+
50+
### Releasing Charts
51+
52+
Maintainer-facing release instructions live in [`charts/README.md`](charts/README.md).
53+
Use that document for chart tag formats, workflow triggers, and post-release checks.
4854

4955
### ArgoCD Examples
5056

charts/README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Helm Charts
2+
3+
This directory contains the maintained Helm charts published from this repository:
4+
5+
- [`ontoserver/`](./ontoserver/) - main Ontoserver chart
6+
- [`ontoserver-extras/`](./ontoserver-extras/) - optional Varnish and OpenTelemetry components
7+
- [`ontoserver-indexer/`](./ontoserver-indexer/) - one-shot indexing Job chart
8+
9+
## Releasing Charts
10+
11+
Charts are released from Git tags via GitHub Actions.
12+
13+
Preferred distribution is the GitHub Pages Helm repository:
14+
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+
Example:
32+
33+
```bash
34+
git tag ontoserver-v0.1.0
35+
git push origin ontoserver-v0.1.0
36+
```
37+
38+
After the first release, confirm:
39+
40+
- GitHub Pages is enabled for the `gh-pages` branch
41+
- the new chart version appears in the Helm repo index
42+
- the corresponding `ghcr.io` package visibility is set as intended
43+
44+
## Releasing Varnish Exporter
45+
46+
The Varnish exporter image is released separately from `.github/workflows/release-varnish-exporter.yml`.
47+
48+
Use a tag in this format:
49+
50+
- `varnish-exporter-vX.Y.Z`
51+
52+
That tag builds and publishes:
53+
54+
- `ghcr.io/aehrc/varnish-exporter`

0 commit comments

Comments
 (0)