Include versioned release notes in GitHub release descriptions - #20
Merged
Merged
Conversation
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.
GitHub releases currently contain artifact metadata and a pointer to
releases.md, omitting the release notes included by the original local release process. Use the newBake::Releases.notesAPI frombake-releases0.6.0 to include the exact version's notes from the merged release checkout before the PR URL, source commit, and gem digest.Move
bake-releasesinto the runtime dependencies (~> 0.6). Missing or empty notes leave a metadata-only description. Existing draft and published release descriptions are preserved on retry, including maintainer edits. Adds documentation, regenerated agent context, and an Unreleased note.Validation: all GitHub checks pass, including release validation and Linux/macOS coverage. Locally, 81 tests / 250 assertions pass with 100% measured coverage (354/354 lines); coverage validation, RuboCop, and documentation coverage (22/22) pass. An unsigned gem build and ordinary-PR release validation pass. Added tests exercise version selection and Markdown formatting, missing notes, and draft-description preservation after an interrupted publish.
This follows socketry/bake-releases#1, released in v0.6.0, and restores release-note content for the bake-modernize migration in socketry/bake-modernize#24.