Now this looks handy: a GitHub action that builds release notes for you:
As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready
You configure the release notes contents using a .github/release-drafter.yml
file in your repo:
template: |
## What’s Changed
$CHANGES
More advanced templates are also possible:
name-template: 'v$NEXT_PATCH_VERSION 🌈'
tag-template: 'v$NEXT_PATCH_VERSION'
categories:
- title: '🚀 Features'
labels:
- 'feature'
- 'enhancement'
- title: '🐛 Bug Fixes'
labels:
- 'fix'
- 'bugfix'
- 'bug'
- title: '🧰 Maintenance'
label: 'chore'
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
template: |
## Changes
$CHANGES
The template above yields this kind of result:
Nice!