chore(git): release process - #294
Open
sabinem wants to merge 4 commits into
Open
Conversation
sabinem
force-pushed
the
chore/release-process
branch
from
September 9, 2026 11:38
71b77db to
622b35b
Compare
The repo had no changelog, so the only account of what a release contains was the commit messages. Keep a Changelog format, hand-maintained, one line per PR. The 0.8.0 entry summarises what is in production rather than reconstructing it commit by commit; it predates the file and says so. Deliberately not generated from commit messages.
sabinem
force-pushed
the
chore/release-process
branch
from
September 9, 2026 12:44
622b35b to
1c0b0c0
Compare
A hand-maintained changelog rots the moment someone forgets to move [Unreleased] on release day. bump now lifts whatever sits under that heading into a dated heading for the version being cut, and leaves [Unreleased] empty again — so a version's notes are exactly what was written while it was being built.
Nothing recorded how a change reaches the running app, and the answer is not the obvious one. Every push to main republishes temporary/*:latest, and an instance running that tag with imagePullPolicy: Always picks it up on any container restart — an eviction or an OOM kill deploys exactly as a rollout restart does. So a merge to main is closer to a deploy than to a checkpoint, and that was written down nowhere. RELEASING.md says so plainly, then covers what follows from it: how to see what an instance is actually serving, how to deploy deliberately, and how to pin one to an immutable <version>-<commit> tag so it stops moving before a demo. It also corrects a belief worth naming: Chart.yaml's appVersion holds back only a deployment that takes the chart's default tag. An instance overridden to a moving tag reads none of it. EOF
sabinem
marked this pull request as draft
September 10, 2026 06:54
sabinem
marked this pull request as ready for review
September 10, 2026 10:36
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR provides:
changelog
the release process written down
CHANGELOG.md: Keep a Changelog, hand-maintained, entry written in the PR that makes the change. [0.8.0] summarises what's in production today.just version::bump: rolls [Unreleased] into a dated heading for the version being cut, so release notes can't be forgotten on release day.RELEASING.md: that merges reach the running app; how to check what an instance serves (footer, or digest comparison); how to deploy deliberately; how to pin or roll back to an immutable - tag; the three version numbers; how to cut a release and make it deployable.README.md/CLAUDE.md: pointers, plus a new invariant for the deploy-on-restart behaviour.