From a754ee0c09f9cbe1d726a3a927902d62dd054929 Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Fri, 3 Nov 2023 21:46:49 -0400 Subject: [PATCH 1/2] docs: configuring automatically generated release notes See https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes. We shall add proper labels when submitting and merging PRs, so release notes can be more automatic. Signed-off-by: Jinzhe Zeng --- .github/release.yml | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/release.yml diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 0000000000..ba73014394 --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,31 @@ +changelog: + exclude: + authors: + - app/pre-commit-ci + - app/dependabot + categories: + - title: Breaking Changes + labels: + - "breaking change" + - title: New Features + labels: + - "new feature" + - title: Enhancement + labels: + - enhancement + - title: Documentation + labels: + - Docs + exclude: + labels: + - build + - bug + - title: Build and release + labels: + - build + - title: Bug fixings + labels: + - bug + - title: Other Changes + labels: + - "*" From 91875b296eb4a5ab0289fa7f2598bde55615a1b7 Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Fri, 3 Nov 2023 22:10:27 -0400 Subject: [PATCH 2/2] add an additional docs label Signed-off-by: Jinzhe Zeng --- .github/release.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/release.yml b/.github/release.yml index ba73014394..382e5db00e 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -15,7 +15,10 @@ changelog: - enhancement - title: Documentation labels: + # automatically added - Docs + # for docs outside the doc directory + - "other docs" exclude: labels: - build