Maintain release notes using GitHub Actions #466
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
This commit sets up a GitHub Actions workflow that uses Release Drafter to automatically maintain release notes on every push. In practice this means that contributors no longer have to manually update the CHANGELOG, which is something that is easy to forget and often introduces tedious merge conflicts. Instead, Release Drafter automatically adds the title of the PR to the GitHub release notes to a draft release, crediting the author of the PR, and linking to the PR number. Release Drafter furthermore organizes the release notes into sections according to the labels assigned to the PRs: -⚠️ Breaking - 🐛 Bug Fix - 📚 Docs - ✨ Feature - 🏠 Housekeeping This also simplifies the release process for maintainers: instead of manually updating the CHANGELOG, all you have to do is press "publish" on the release draft on GitHub. As part of this commit I have documented the release process in `README.md` and the PR labeling process in `CONTRIBUTING.md`.
mattbrictson
force-pushed
the
chores/set-up-release-drafter
branch
from
fbd21b4
to
6688153
Compare
Closed
|
Okay lets try it! |
|
I can't seem to copy the icons in the text labels on Linux, is that a problem? |
|
We don't have to use the icons but the important part is that the label text must exactly match the |
|
@mattbrictson Thanks! I've created the labels now! |
|
Great! I am not a maintainer so I am not able to see the draft release notes. Is it working? |
|
The draft release notes should show up at the top of this page: https://github.com/guard/listen/releases |
|
@mattbrictson Yeah it worked but it prepared a draft for the v3.2.0 release which is already released, so I'll update them and publish them manually this time! Thanks again! |
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.
This commit sets up a GitHub Actions workflow that uses Release Drafter to automatically maintain release notes on every push.
In practice this means that contributors no longer have to manually update the CHANGELOG, which is something that is easy to forget and often introduces tedious merge conflicts.
Instead, Release Drafter automatically adds the title of the PR to the GitHub release notes to a draft release, crediting the author of the PR, and linking to the PR number. Release Drafter furthermore organizes the release notes into sections according to the labels assigned to the PRs:
This also simplifies the release process for maintainers: instead of manually updating the CHANGELOG, all you have to do is press "publish" on the release draft on GitHub.
As part of this commit I have documented the release process in
README.mdand the PR labeling process inCONTRIBUTING.md.Before merging this PR a project administrator will need to create the following labels using this GitHub page: