Skip to content

RELEASING.md

Latest commit

 

History

History
96 lines (69 loc) · 3.13 KB

RELEASING.md

File metadata and controls

96 lines (69 loc) · 3.13 KB
Raw

Releasing

One tag publishes everything:

# 1. Bump the chart. version and appVersion must both equal the tag,
#    or the release workflow refuses to publish.
vim charts/presage/Chart.yaml

git commit -am "release: v0.2.0"
git tag v0.2.0
git push origin main v0.2.0

That produces:

Artifact Where
Controller image ghcr.io/breezycourses/presage:0.2.0
Forecaster image ghcr.io/breezycourses/presage-forecaster:0.2.0
Helm chart oci://ghcr.io/breezycourses/charts/presage:0.2.0
Artifact Hub metadata ghcr.io/breezycourses/charts/presage:artifacthub.io

Images are built on native amd64 and arm64 runners and joined into a manifest list. They are not cross-built under QEMU: the forecaster image installs torch, and emulated arm64 turns a three-minute build into a forty-minute one.

What main publishes

Every push to main publishes dev images:

ghcr.io/breezycourses/presage:main
ghcr.io/breezycourses/presage:0.1.0-dev.<short-sha>

latest follows releases only — pointing it at main would make the default tag a moving target nobody chose to install.

The chart is published on tags only. Every chart version becomes a row on the Artifact Hub listing, and a row per commit would bury the releases people actually want.

One-time setup

These are manual because they need account-level permissions a workflow token does not have. Until they are done, nothing is installable and the Artifact Hub listing will not appear — which is the state the project was in before this document existed.

1. Make the packages public

A package pushed from a private repository is private, and helm install against it fails with an authentication error rather than anything explanatory. After the first release, for each of presage, presage-forecaster, and charts/presage:

github.com/orgs/breezycourses/packages → package → Package settings → Change visibility → Public

2. Add the repository to Artifact Hub

Sign in at artifacthub.io, then Control Panel → Repositories → Add, with:

Field Value
Kind Helm charts
Name presage
URL oci://ghcr.io/breezycourses/charts/presage

The URL must point at the chart itself, not at the namespace containing it. oci://ghcr.io/breezycourses/charts will not index.

3. Claim ownership

Done: the repository ID is in artifacthub-repo.yml and the release workflow pushes it to the registry. Artifact Hub pulls that artifact and matches the ID against the registered repository.

Checking a release

helm show chart oci://ghcr.io/breezycourses/charts/presage --version 0.2.0
docker buildx imagetools inspect ghcr.io/breezycourses/presage:0.2.0
oras manifest fetch ghcr.io/breezycourses/charts/presage:artifacthub.io

The last one is the check worth remembering: if it 404s, Artifact Hub has no metadata for the repository no matter what the git tree says.

Versioning

v1alpha1 is pre-1.0 and the API may change between minor versions. The chart version and the app version are kept identical — one project, one number — and the release workflow enforces it.