docs(releasing): document release-note generation in 'Cutting a release'#173
Merged
Conversation
…release' The release workflow already passes generate_release_notes: true, but the 'Cutting a release' steps didn't mention it. Add a step explaining that the release body is filled from merged PR titles since the previous tag (hence clean, conventional titles + squash-merge), that it can be edited after publishing, and how to categorize notes via .github/release.yml.
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.
The release workflow already auto-generates the GitHub Release body (it passes
generate_release_notes: true), but the Cutting a release steps indocs/RELEASING.mdnever said so. This documents it.Adds a step 4, "Review the release notes", covering:
v*tag (categorized changelog + contributor credits + Full Changelog link)..github/release.yml— no workflow change needed.Also tweaks the intro line to mention the release is published "with auto-generated release notes". Docs-only.
🤖 Generated with Claude Code