Support for generating release notes #1083
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
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.
As discussed elsewhere, this is the release drafter, in use by the other clients, we currently maintain. It aims to help making the process of writing release notes better. The drafter takes the titles of pull requests, and injects them into the release notes, in specific locations, as per the template included in the PR.
To use effectively we need to start labeled PRs prior to merge with one of the tags below, having created the labels.
The labels used are:
experimental - Changes that are shared, and experimental - potentially to be promoted or walked back, use this label.
breakingchange - When something is labeled thus, it appears, called out as a breaking change.
feature - Anything with this label is listed as a feature
bug - PRs labeled with bugs are marked as bugs fixed
maintenance - This label is used for all maintenance commits, CI, documentation, etc.
skip-changelog - If for some reason, there's a commit that you'd like to exclude from the changelog, add this label. Note: I've never used it, but it seems more complete to support.
Today, this version of the drafter works acts upon merges to master, and maintains a single, auto-generated list. Upon release, using the GitHub release workflow, the maintainer edits the draft release, to tag and publish.
As an added benefit, in many clients (see example) we automate the release to the appropriate package manager, when a release is published.