Skip to content

docs(releasing): list the six files a version bump touches - #525

Merged
raeq merged 1 commit into
mainfrom
docs/releasing-version-files
Jul 14, 2026
Merged

docs(releasing): list the six files a version bump touches#525
raeq merged 1 commit into
mainfrom
docs/releasing-version-files

Conversation

@raeq

@raeq raeq commented Jul 14, 2026

Copy link
Copy Markdown
Owner

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.cff and uv.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:

  • the six files that carry the version (the 4 manifests + CITATION.cff + uv.lock, with uv lock regenerating only the editable entry);
  • the two things that look like versions but must not change — #[deprecated(since = "X")] and .. deprecated:: X markers;
  • the glue-crate version = "0.0.0" + minor-only disarm_core pin (untouched by a patch);
  • a pre-tag grep sweep for stray references.

Docs-only; no code change.

Assisted-by: Claude Code:claude-opus-4-8

Copilot AI review requested due to automatic review settings July 14, 2026 06:14

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.cff and uv.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.

Comment thread RELEASING.md Outdated
Comment thread RELEASING.md Outdated
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
@raeq

raeq commented Jul 14, 2026

Copy link
Copy Markdown
Owner Author

Both fixed: put the #[deprecated(since = "X")] span on a single line so it renders, and updated the sweep command to actually implement the exclusions it describes — grep -rn "<old-version>" --exclude=CHANGELOG.md . | grep -v deprecated.

@raeq
raeq force-pushed the docs/releasing-version-files branch from 84df7f1 to 7e49333 Compare July 14, 2026 06:20
@raeq
raeq merged commit 2e2ce41 into main Jul 14, 2026
18 checks passed
@raeq
raeq deleted the docs/releasing-version-files branch July 14, 2026 06:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants