Repository navigation
Let a release carry a hand-written changelog - #58
Merged
Merged
Conversation
The release notes list every commit since the previous tag. When a range is
mostly refactors with no effect for users, that list buries the few changes
that matter.
A `changelog` input on the Release workflow takes markdown that replaces the
commit list; the "Full Changelog" compare link stays. Left empty, the notes
are the commit list as before. The UI only offers a one-line box, so a
multi-line changelog is passed from the CLI:
gh workflow run release.yml -f bump=minor -f changelog="$(cat changelog.md)"
The value reaches the script through the environment rather than being
interpolated into it, so quotes, backticks and $(...) in the markdown stay
text.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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 notes are generated from every commit since the previous tag. The next release covers about 30 commits, and most of them are refactors that change nothing for users, so the few real changes get lost in the list.
This adds one optional
changeloginput to the Release workflow:The same notes feed the GitHub release, the docs Changelog tab and the Discord announcement. The Discord 3500-character truncation is unchanged.
The Actions UI only offers a one-line text box, so a multi-line changelog is passed from the CLI:
The value reaches the script through an environment variable, never interpolated into the script, so quotes, backticks and
$(...)in the markdown stay text.Tested: YAML parses, and the notes block was run locally with and without a changelog, including one containing backticks and
$(...). The workflow itself hasn't run.🤖 Generated with Claude Code