docs: add an initial ruleset for better Github release notes

ecmwf · Dec 13, 2024 · 9db3e3e · 9db3e3e
1 parent 2ca2ba5
commit 9db3e3e
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/.github/release.yml b/.github/release.yml
@@ -0,0 +1,21 @@
+# .github/release.yml
+# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
+
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+      - no-changelog
+
+    authors:
+      - pre-commit-ci[bot]
+  categories:
+    - title: Breaking Changes 🛠
+      labels:
+        - breaking-change
+    - title: Exciting New Features 🎉
+      labels:
+        - enhancement
+    - title: Other Changes
+      labels:
+        - "*"