feat: auto generate release notes #57698
Merged
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.
Summary
None
Purpose of change
Github is able to generate some pretty nice looking release notes, we don't have much time between releases, so it's not gonna be a large release changelog, still pretty things are very nice to have
Describe the solution
It took some time to figure out how to do this but this pretty much explained all the needed steps for me https://github.com/cli/cli/blob/trunk/.github/workflows/releases.yml#L24 https://github.com/cli/cli/blob/trunk/.github/workflows/releases.yml#L45
I don't think many people look at the releases, but it's nice to have a simple changelog with pr title and listed contributors
see a changelog with a lot more pr in it https://github.com/I-am-Erk/CDDA-Tilesets/releases/tag/2022-05-08
Describe alternatives you've considered
Testing
See this release https://github.com/casswedson/Cataclysm-DDA/releases/tag/cdda-experimental-2022-05-14-1831 generated by this commit and pr casswedson@d18a84e casswedson#35
Additional context