From 12cece2055fa3dbd20729eaf561a12af7b6fca7a Mon Sep 17 00:00:00 2001 From: Si Beaumont Date: Tue, 13 Jun 2023 15:51:39 +0100 Subject: [PATCH] Add .github/release.yml to automate drafting release notes (#8) ### 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 --- .github/release.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .github/release.yml diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 0000000..4d18da5 --- /dev/null +++ b/.github/release.yml @@ -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 + - "*"