fix(changelog): render the release body as Markdown, tags as plain text - #50
Merged
Conversation
The notes render de-Markdowns the changelog section for a plain-text git tag message, and draft-release reused that same text as the GitHub release body. Stripping the backticks exposed inline-code @ tokens, which GitHub autolinked as bogus contributor @mentions in the body. The changelog action's notes mode gains a `format` input: `plain` (default) keeps the de-Markdown for the annotated git tag message, `markdown` emits the section as authored for the release body, where inline code stops the autolinking. draft-release renders both: Markdown into release-notes.md for the draft body, plain into release-tag.md for the rcN marker (and, through the runbook, the signed tag). The Markdown body also drops the redundant leading title line, since GitHub shows the release title separately.
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 notes render de-Markdowns the changelog section for a plain-text git tag message, and draft-release reused that same text as the GitHub release body. Stripping the backticks exposed inline-code @ tokens, which GitHub autolinked as bogus contributor @mentions in the body.
The changelog action's notes mode gains a
formatinput:plain(default) keeps the de-Markdown for the annotated git tag message,markdownemits the section as authored for the release body, where inline code stops the autolinking. draft-release renders both: Markdown into release-notes.md for the draft body, plain into release-tag.md for the rcN marker (and, through the runbook, the signed tag). The Markdown body also drops the redundant leading title line, since GitHub shows the release title separately.