PR Body Templates

By default brel writes its own release PR body. To customize it, point release_pr.pr_template_file at a Handlebars template in your repository:

[release_pr]
pr_template_file = ".github/brel/release-pr-body.hbs"

If rendering fails, brel release-pr exits with an error.

Available variables

Variable	Description
`version`	Next version, e.g. `1.2.3`.
`tag`	Rendered tag, e.g. `v1.2.3`.
`base_branch`	The branch the PR targets (your default branch).
`release_branch`	The rendered release branch name.
`commits`	Array of commits in the release, each with `sha_short` and `subject`.

Example template

<!-- managed-by: brel -->

## Release {{tag}}

Merging this PR releases **{{version}}** to `{{base_branch}}`.

### Commits

{{#each commits}}
- `{{sha_short}}` {{subject}}
{{/each}}