chore(docs): add changelog and document release process - #297
Merged
Conversation
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.
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.
RELEASING.md describes the current release process and what happens if a feature is merged to main. It also decribes the branching model and the versioning of App and Charts.
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.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.