docs: add a release checklist runbook#82
Merged
Conversation
Adds docs/RELEASING.md, a top-to-bottom pre-release checklist covering version (single source of truth in pyproject, __version__ derives from metadata), CHANGELOG, README/docs sync, ALTIKVA headers, the Gitflow release/tag/back-merge dance, the pypi approval gate, and post-release verification. Encodes the gotchas hit during 0.5.0 (the version-drift banner, uv wheel caching, PyPI append-only). Linked from CLAUDE.md.
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.
Adds
docs/RELEASING.mdand links it fromCLAUDE.md. A top-to-bottom checklist for every release:pyproject.toml;__version__derives from metadata, do not re-hardcode).pypiapproval gate.Encodes the gotchas from 0.5.0: the version-drift banner, uv wheel caching (builds from committed HEAD, reuses cached wheel on same version), PyPI append-only. Docs-only.