Generate the release notes automatically - #8
Merged
Merged
Conversation
raszi
changed the title
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.
GitHub can build the release notes from the pull request labels. This branch adds two files.
.github/release.ymlgroups the pull requests into categories that follow the conventional changelog format. The categories match the labels of the repository:feat,fix,perf,revert,docs,refactor,style,test,build,ci, andchore. Every other pull request goes into "Other changes"..github/workflows/release.ymlhas two jobs. After each merge tomain, the first job replaces a draft release with the title "Unreleased". The draft shows the upcoming changes before a real release. After a push of av*tag, the second job publishes the release and removes the stale draft.Do not publish the "Unreleased" draft. It would create a tag with the name
unreleased. To make a release, push a tag such asv0.3.0.