- Install the Release Drafter GitHub App into the repositories you wish to automatically create releases in.
- Add a
.github/release-drafter.ymlconfiguration file to each repository.
For example, take the following
.github/release-drafter.yml file in a repository:
template: | ## What’s Changed $CHANGES
As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready:
See the readme for full documentation of all the options.
⚠️ Installation Permissions
Release Drafter requires full write, because GitHub does not offer a limited scope for only writing releases. Don't install Release Drafter to your entire GitHub account — only add the repositories you want to draft releases on.