Skip to content

Commit 8d8aa43

Browse files
Add .github/release.yml to automate drafting release notes (#14)
### 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 Signed-off-by: Si Beaumont <[email protected]>
1 parent 3c21ae3 commit 8d8aa43

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

.github/release.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
changelog:
2+
categories:
3+
- title: SemVer Major
4+
labels:
5+
- semver/major
6+
- title: SemVer Minor
7+
labels:
8+
- semver/minor
9+
- title: SemVer Patch
10+
labels:
11+
- semver/patch
12+
- title: Other Changes
13+
labels:
14+
- semver/none
15+
- "*"

0 commit comments

Comments
 (0)