ci(release): single RELEASE_NOTES.md + check-notes gate against stale bodies - #107
Merged
Conversation
… bodies v1.2.0 and v1.2.1 both published with the previous release's "What's New" because the body was a static string duplicated across the three release jobs and nobody updated it before tagging. Restructure so that cannot recur: - RELEASE_NOTES.md (repo root) is now the single release body, consumed by all three jobs via body_path — no more triple copies to keep in sync. - New check-notes job: on tag pushes it fails, in seconds and before any build starts, unless RELEASE_NOTES.md mentions "FreeCCR <version>" for the tagged version. Non-tag runs (workflow_dispatch) pass through. - CLAUDE.md documents the new location and the tag-time contract. Supersedes #103 (which refreshed the three inline copies in place). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015CWWLim8DnE9WqbqqmHV26
toonoumi
force-pushed
the
ci/release-notes-guard
branch
from
July 10, 2026 03:20
03646ef to
68d5731
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
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.
Problem
v1.2.0 and v1.2.1 both published with the previous release's "What's New" (both fixed after the fact with
gh release edit). Root cause: the release body was a static string duplicated across the three build jobs inrelease.yml, updated by hand — nothing failed when it was stale at tag time.Fix
RELEASE_NOTES.md(repo root) is now the single source of the release body. All three jobs consume it viabody_path, read at the tagged commit. No more triple copies / KEEP IN SYNC comments. It currently carries the v1.2.1 notes (matching the live release page).check-notesjob gates the build. On tag pushes it fails — in seconds, before any ~30-minute build starts — unless the file mentionsFreeCCR <version>for the tagged version. All three build jobsneeds: check-notes. Manualworkflow_dispatchruns pass through unchanged.RELEASE_NOTES.mdbefore tagging.So the failure mode changes from "silently publishes last release's notes" to "tag build fails immediately with an error naming the file and version".
Verification
yaml.safe_loadparses; jobs =check-notes, build-windows, build-macos, build-linux, all three buildsneeds: check-notes; exactly 3body_pathentries and zero inline bodies remain.v1.2.1against the current file, fails forv1.3.0(stale-notes scenario).#103 (which refreshed the three inline copies in place) was merged while this was in flight; this branch is rebased on top of it and deletes those inline copies in favour of the file.
🤖 Generated with Claude Code
https://claude.ai/code/session_015CWWLim8DnE9WqbqqmHV26