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.
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.