-
Notifications
You must be signed in to change notification settings - Fork 242
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Maintain release notes using GitHub Actions
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`.
- Loading branch information
1 parent
cd657cf
commit 6688153
Showing
4 changed files
with
55 additions
and
1 deletion.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
name-template: "v$NEXT_PATCH_VERSION" | ||
tag-template: "v$NEXT_PATCH_VERSION" | ||
categories: | ||
- title: "⚠️ Breaking Changes" | ||
label: "⚠️ Breaking" | ||
- title: "✨ New Features" | ||
label: "✨ Feature" | ||
- title: "🐛 Bug Fixes" | ||
label: "🐛 Bug Fix" | ||
- title: "📚 Documentation" | ||
label: "📚 Docs" | ||
- title: "🏠 Housekeeping" | ||
label: "🏠 Housekeeping" | ||
change-template: "- $TITLE (#$NUMBER) @$AUTHOR" | ||
no-changes-template: "- No changes" | ||
template: | | ||
$CHANGES |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
on: push | ||
name: Push | ||
jobs: | ||
draftRelease: | ||
name: Draft Release | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@master | ||
- name: Draft Release | ||
uses: toolmantim/release-drafter@v5.2.0 | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
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 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