Add auto-generated changelog to GitHub releases

Generated notes include all pull requests contained in a given release. PR authors are tagged, giving them proper credit. Note that the generated notes are appended to the old format, they do not replace it. Signed-off-by: nscuro <[email protected]>
DependencyTrack · Feb 27, 2024 · df6aa81 · df6aa81
1 parent 6718b8b
commit df6aa81
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/.github/release.yml b/.github/release.yml
@@ -0,0 +1,14 @@
+changelog:
+  categories:
+  - title: Enhancements 🚀
+    labels:
+    - enhancement
+  - title: Bug Fixes 🐛
+    labels:
+    - defect
+  - title: Dependency Updates 🤖
+    labels:
+    - dependencies
+  - title: Other Changes
+    labels:
+    - "*"
diff --git a/.github/workflows/ci-publish.yaml b/.github/workflows/ci-publish.yaml
@@ -74,6 +74,9 @@ jobs:
           \`\`\`
           EOF
 
+          gh release view ${{ needs.read-version.outputs.version }} \
+            --json body --jq .body >> .github/default-release-notes.md
+
           gh release edit ${{ needs.read-version.outputs.version }} \
             --notes-file ".github/default-release-notes.md"
 

diff --git a/.github/workflows/ci-release.yaml b/.github/workflows/ci-release.yaml
@@ -52,4 +52,4 @@ jobs:
           gh release create "${VERSION}" ${GH_OPTS} \
             --target "${{ github.ref_name }}" \
             --title "${VERSION}" \
-            --notes-file ".github/default-release-notes.md"
+            --generate-notes