About Release Drafter
Release Drafter is an open source GitHub Action that keeps a draft release up to date as pull requests are merged. When you are ready to ship, the notes are already written.
What it does
The action follows the main branch and adds each merged pull request to a draft release. A configuration file lets you group changes into sections, such as features and fixes, based on labels. It can also apply labels to pull requests with an autolabeler. When you publish the draft, the notes are ready to go.
Key features
- Draft release updated on each merge
- Groups changes by label
- Autolabeler for pull requests
- Excludes bots from change authors
- Runs as a workflow step on GitHub
Who it's for
Release Drafter suits open source and product teams on GitHub that publish releases regularly. It is most useful when pull request titles and labels are kept tidy.
Pricing and good to know
The project is open source under the ISC license and free to use. It runs inside GitHub Actions, so it needs a repository on GitHub and a workflow file. The notes stay a draft until someone publishes them, so a person still decides what goes out.
Highlights
- Keeps a draft release updated on each merge
- Groups pull requests into sections by label
- Applies labels to pull requests automatically
- Excludes bots from the list of change authors
- Runs as a step in a GitHub workflow
