Closed mattbrictson closed 4 years ago
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 label:
listed in release-drafter.yml.
@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!
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.md
and the PR labeling process inCONTRIBUTING.md
.Before merging this PR a project administrator will need to create the following labels using this GitHub page: