Automatically maintain release notes using GitHub Actions #472
Conversation
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. Here is an example from another project: https://github.com/mattbrictson/airbrussh/releases/tag/v1.3.3
|
I'm not thrilled about all the other emojis in the changelog, I think this is a bit unnecessary and kitschy but the rest of it looks great. Let's give it a try? We also need a corresponding PR in the |
No problem, I've updated the Release Drafter config to remove the emoji. Note that maintainers will have to remember to add the appropriate label to a PR before merging it, if they want it to be automatically categorized in the release notes. I've named all the labels starting with a PR: prefix:
(However if you don't use one of these labels, the PR will still automatically be added to the release notes, just in a catch-all section. So it's not a big deal if you forget.) Should this be documented somewhere for current and future maintainers? E.g.
I created a branch for now. I didn't want to merge it into capistrano/danger master yet because that is being used by other capistrano projects that still have CHANGELOGs. |
|
Good point, this all looks good to me, and honestly the emojis in the change-log for Nice stuff mate, LGTM. |
mattbrictson
force-pushed
the
chores/use-github-actions-for-releases
branch
from
7eb4255
to
b245b18
Compare
|
Thanks! I'll add the emoji back in and get this merged. 👍 |
|
Thank you for for your patience dude 🙏 |
|
It's working 🙂
|
|
so pretty! |
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 in 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.
Here is an example from another project:
https://github.com/mattbrictson/airbrussh/releases/tag/v1.3.3