From 5b2b850cfd2644a1e31385f420e9c6fd84437972 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tom=C3=A1s=20Gr=C3=BCner?=
 <47506558+MegaRedHand@users.noreply.github.com>
Date: Fri, 17 Jan 2025 13:13:53 -0300
Subject: [PATCH] docs: add GitHub release changelog configuration (#229)

This PR adds a GitHub release configuration, which should simplify
changelog generation.
---
 .github/PULL_REQUEST_TEMPLATE.md | 10 ++++++++++
 .github/release.yml              | 33 ++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+)
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md
 create mode 100644 .github/release.yml

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..66b81907
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,10 @@
+Fixes #
+
+### What Changed?
+<!-- Describe the changes made in this pull request -->
+
+### Reviewer Checklist
+
+- [ ] New features are tested and documented
+- [ ] PR has one of the `changelog-X` labels (if applies)
+- [ ] Code deprecates any old functionality before removing it
diff --git a/.github/release.yml b/.github/release.yml
new file mode 100644
index 00000000..2a9ae979
--- /dev/null
+++ b/.github/release.yml
@@ -0,0 +1,33 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+  categories:
+    # vulnerabilities
+    - title: Security 🔒
+      labels:
+        - changelog-security
+    # new features
+    - title: Added 🎉
+      labels:
+        - changelog-added
+    # changes in existing functionality
+    - title: Changed 🛠
+      labels:
+        - changelog-changed
+    # soon-to-be removed features
+    - title: Deprecated ⚠️
+      labels:
+        - changelog-deprecated
+    # now removed features
+    - title: Removed 🗑
+      labels:
+        - changelog-removed
+    # documentation was added or changed
+    - title: Documentation 📚
+      labels:
+        - changelog-documentation
+
+    - title: Other Changes
+      labels:
+        - "*"