Release docs gate: changelog required, release notes derived from it#15
Merged
Conversation
…rom it A release can no longer ship with stale docs. The release workflow now fails before publishing unless: - obj.version in the Spoon matches the tag being released - CHANGELOG.md has an entry for the tag The release body is built from that changelog entry (plus the install instructions and auto-generated notes), so writing the changelog IS writing the release notes. CHANGELOG.md added and backfilled for v0.5.0 and v0.6.0; README links it and documents the rule. Claude-Session: https://claude.ai/code/session_018YxEAK2gUQySh3EUW9crDW
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.
Summary
Follow-up to v0.6.0 shipping with only auto-generated notes: the release process now enforces doc updates instead of relying on memory.
obj.versionmatches the tag andCHANGELOG.mdhas a## <tag>entryCHANGELOG.mdadded, backfilled for v0.5.0 and v0.6.0Testing
https://claude.ai/code/session_018YxEAK2gUQySh3EUW9crDW