From 54f5993b2ae5cf3ba9f23ccfaf0b81a2aec08b9d Mon Sep 17 00:00:00 2001 From: Nick Cross Date: Fri, 27 Mar 2026 17:17:45 +0000 Subject: [PATCH 1/3] Add release note generation --- .github/release.yml | 12 ++++++++++++ .github/workflows/maven-release.yml | 4 ++++ README.md | 2 ++ 3 files changed, 18 insertions(+) create mode 100644 .github/release.yml diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 0000000..fec4711 --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,12 @@ +# From https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#creating-automatically-generated-release-notes-for-a-new-release +changelog: + categories: + - title: 🏕 Changes + labels: + - '*' + exclude: + labels: + - dependencies + - title: 👒 Dependencies + labels: + - dependencies diff --git a/.github/workflows/maven-release.yml b/.github/workflows/maven-release.yml index 0776858..aa08233 100644 --- a/.github/workflows/maven-release.yml +++ b/.github/workflows/maven-release.yml @@ -105,3 +105,7 @@ jobs: env: # Use the standard GITHUB_TOKEN or a Custom PAT if pushing to other repos GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: Create the GH Release + uses: softprops/action-gh-release@v2 + with: + generate_release_notes: true diff --git a/README.md b/README.md index d616417..a1198c1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,4 @@ # shared-github-actions Repository to store workflows (and other stuff) that we'll re-use in other PNC repositories + +A sample `release.yml` configuration file from the [GitHub documentation](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes) has been added to `.github/release.yml` - this can be copied to each relevant repository. \ No newline at end of file From 056dbe37e4102ef35ced25cafc21cf9c27117dae Mon Sep 17 00:00:00 2001 From: Nick Cross Date: Thu, 9 Apr 2026 10:02:26 +0100 Subject: [PATCH 2/3] Call the github CLI using release notes directly --- .github/workflows/maven-release.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/maven-release.yml b/.github/workflows/maven-release.yml index aa08233..3a0b60b 100644 --- a/.github/workflows/maven-release.yml +++ b/.github/workflows/maven-release.yml @@ -106,6 +106,4 @@ jobs: # Use the standard GITHUB_TOKEN or a Custom PAT if pushing to other repos GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - name: Create the GH Release - uses: softprops/action-gh-release@v2 - with: - generate_release_notes: true + run: gh release create --generate-notes From 472d9be0d5aa79bea1c04a1659ec5b98efa5c955 Mon Sep 17 00:00:00 2001 From: Nick Cross Date: Thu, 9 Apr 2026 10:38:21 +0100 Subject: [PATCH 3/3] Restructure release.yml to categorise release notes --- .github/release.yml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/release.yml b/.github/release.yml index fec4711..e7a74b9 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -1,12 +1,17 @@ # From https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#creating-automatically-generated-release-notes-for-a-new-release changelog: categories: - - title: 🏕 Changes + - title: 🐛 Fixes / 🚀 Enhancements labels: - '*' exclude: labels: - dependencies - - title: 👒 Dependencies + - title: 👒 Project Dependencies labels: - dependencies + - java + - title: 👒 CI Dependencies + labels: + - dependencies + - github_actions