docs(releasing): list the six files a version bump touches - #525
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds release-process documentation to reduce the chance of shipping inconsistent version metadata by explicitly listing every file that must be updated during a version bump.
Changes:
- Documents the six files that must be updated for a version bump (including
CITATION.cffanduv.lock). - Adds guidance on avoiding accidental edits to deprecation markers and glue-crate versioning.
- Adds a pre-tag “grep sweep” step to catch stray references to the old version.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
A version bump must update six files, not just the four manifests: CITATION.cff and uv.lock are away from the manifests and easy to miss (the 0.11.1 PR left both stale — caught in review before publish, which would otherwise have shipped inconsistent citation/lock metadata). Document the full list, the two markers that look like versions but must not change (`#[deprecated(since=)]` / `.. deprecated::`), the glue-crate minor-only pin, and a pre-tag grep sweep. Signed-off-by: Richard Quinn <quinn.richard@gmail.com> Assisted-by: Claude Code:claude-opus-4-8
Owner
Author
|
Both fixed: put the |
raeq
force-pushed
the
docs/releasing-version-files
branch
from
July 14, 2026 06:20
84df7f1 to
7e49333
Compare
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
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 a "Where the version lives — bump all six" subsection to
RELEASING.md.During the 0.11.1 release, Copilot's review caught that the version bump had missed
CITATION.cffanduv.lock— both live away from the four manifests and are easy to miss. They were fixed before publish, so the shipped metadata is consistent, but the gap is worth documenting so the next release doesn't hit it.The new subsection lists:
CITATION.cff+uv.lock, withuv lockregenerating only the editable entry);#[deprecated(since = "X")]and.. deprecated:: Xmarkers;version = "0.0.0"+ minor-onlydisarm_corepin (untouched by a patch);grepsweep for stray references.Docs-only; no code change.
Assisted-by: Claude Code:claude-opus-4-8