probot.github.io/_apps/release-drafter.md

title, description, slug, screenshots, authors, repository, host, stars, updated, installations, organizations

title	description	slug	screenshots	authors	repository	host	stars	updated	installations	organizations
Release Drafter	Drafts your next release notes as pull requests are merged into master.	release-drafter	https://raw.githubusercontent.com/toolmantim/release-drafter/master/design/screenshot.png	toolmantim	toolmantim/release-drafter	https://release-drafter.now.sh	183	2018-07-14 06:39:07 UTC	31	benbalter balloob jeanregisser home-assistant nashaofu palkan tansengming toolmantim motss buildkite-plugins

Usage

1. Install the Release Drafter GitHub App into the repositories you wish to create releases in.
2. Add a .github/release-drafter.yml configuration file to each repository.

Example

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.

Template variables

You can use any of the following variables in your template, and they’ll be substituted when the release is regenerated:

Variable	Description
$CHANGES	The markdown list of pull requests that have been merged.
$PREVIOUS_TAG	The previous releases’s tag.

Configuration options

You can configure Release Drafter using the following key in your .github/release-drafter.yml file:

Key	Required	Description
template	Required	The template for the body of the draft release. Use template variables to insert values.
branches	Optional	The branches to listen for configuration updates to .github/release-drafter.yml and for merge commits. Useful if you want to test the app on a pull request branch. Default is the repository’s default branch.

Release Drafter also supports Probot Config, if you want to store your configuration files in a central repository.