From 428b7862b9774c834b3cb94243bc749b33160a44 Mon Sep 17 00:00:00 2001 From: Eden Zimbelman Date: Thu, 1 Oct 2026 15:19:42 -0700 Subject: [PATCH] chore: categorize generated release notes by label Co-Authored-By: Claude --- .github/maintainers_guide.md | 3 ++- .github/release.yml | 24 ++++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 .github/release.yml diff --git a/.github/maintainers_guide.md b/.github/maintainers_guide.md index 8e6b7999d..cf39c7ea2 100644 --- a/.github/maintainers_guide.md +++ b/.github/maintainers_guide.md @@ -128,8 +128,9 @@ These `-SNAPSHOT` versions are intended to be overwritten. This enables develope * Follow the workflow logs and [publishing](https://central.sonatype.com/publishing/deployments) step with patience to start debugging if errors appear * Create a GitHub Release * Open https://github.com/slackapi/java-slack-sdk/releases/new?tag=v${version} + * Click the "Generate release notes" button to list changes grouped by the labels in [`.github/release.yml`](./release.yml) + * Edit the resulting notes to ensure they have decent messaging that is understandable by non-contributors, but each change should still have its own line * [Look at previous releases](https://github.com/slackapi/java-slack-sdk/releases) and follow their layouts - * Prepare a release note by `git log --pretty=format:'%h %s by %an' --abbrev-commit | grep -v "Merge pull request " | head -50` * (Slack Internal) Communicate the release internally. Include a link to the GitHub Release(s). * (Slack Internal) Tweet? Not necessary for patch updates, might be needed for minor updates, definitely needed for major updates. Include a link to the GitHub Release(s). diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 000000000..b2574b7cc --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,24 @@ +# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes +changelog: + categories: + - title: ๐Ÿš€ Enhancements + labels: + - enhancement + - title: ๐Ÿ› Bug Fixes + labels: + - bug + - title: ๐Ÿ“š Documentation + labels: + - docs + - title: ๐Ÿค– Build + labels: + - build + - title: ๐Ÿงช Testing/Code Health + labels: + - code health + - title: ๐Ÿ”’ Security + labels: + - security + - title: ๐Ÿ“ฆ Other changes + labels: + - "*"