Skip to content

Commit

Permalink
Add .github/release.yml to automate drafting release notes (#8)
Browse files Browse the repository at this point in the history
### Motivation

We want to provide consistent and comprehensive release notes when
making
a release. Github supports generating draft release notes based on
labels
attached to PRs to make this simpler.

### Modifications

- Add .github/release.yml with SemVer based release notes sections.

### Result

When creating a release, Github should populate the release notes based
on the
PRs that have been merged since the last release and group them based on
their
labels.

### Test Plan

None.

### Reference


https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
  • Loading branch information
simonjbeaumont authored Jun 13, 2023
1 parent 0ce8765 commit 12cece2
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
changelog:
categories:
- title: SemVer Major
labels:
- semver/major
- title: SemVer Minor
labels:
- semver/minor
- title: SemVer Patch
labels:
- semver/patch
- title: Other Changes
labels:
- semver/none
- "*"

0 comments on commit 12cece2

Please sign in to comment.