fix: don't format github-native changelog #2802
Merged
Conversation
This file contains 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
The Github changelog generation API returns a pre-formatted changelog. The current implementation prefixes every line of that log with "* ". This operation breaks the formatting. This change makes goreleaser treat github-native changelog as-is, without trying to modify it.
pull-request-size
bot
added
the
size/XS
|
good catch! thanks for the PR! |
dirien
pushed a commit
to dirien/goreleaser
that referenced
this pull request
Jan 4, 2022
The Github changelog generation API returns a pre-formatted changelog. The current implementation prefixes every line of that log with "* ". This operation breaks the formatting. This change makes goreleaser treat github-native changelog as-is, without trying to modify it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Thank you for building goreleaser! While setting it up on https://github.com/pelletier/go-toml/tree/v2, I've noticed that when using the
github-nativechangelog setting and publishing releases to GitHub, the resulting release had an odd formatting issue (see below).The Github changelog generation API returns a pre-formatted changelog. The current implementation prefixes every line of that log with "* ". This operation breaks the formatting.
This change makes goreleaser treat github-native changelog as-is, without trying to modify it.
I tried to write a unit test for this, but couldn't find a good way to both mock the
githubNativeChangelogerand evaluate the execution ofPipe.Run.Would love to hear your thoughts on that change!
Formatting: