From 02f48cd3def10a6c312cc9b22f0679019900ea1b 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 12:21:54 -0300 Subject: [PATCH 1/4] feat: add GitHub release configuration --- .github/release.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/release.yml diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 00000000..c04b94a0 --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,14 @@ +changelog: + exclude: + labels: + - ignore-for-release + categories: + - title: Breaking Changes 🛠 + labels: + - breaking-change + - title: Exciting New Features 🎉 + labels: + - enhancement + - title: Other Changes + labels: + - "*" From 7eac25a35fd7ff84bbb81f9df1665b5464664260 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 12:26:22 -0300 Subject: [PATCH 2/4] docs: include PR template with checklist --- .github/PULL_REQUEST_TEMPLATE.md | 11 +++++++++++ .github/release.yml | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..9e25a1b9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ +Fixes # + +### What Changed? + + +### Reviewer Checklist + +- [ ] New features are tested and documented +- [ ] If PR introduces breaking changes, it is labeled with `breaking-change` +- [ ] If PR introduces new features, it is labeled with `new-feature` +- [ ] Code deprecates any old functionality before removing it diff --git a/.github/release.yml b/.github/release.yml index c04b94a0..5f45c0f2 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -8,7 +8,7 @@ changelog: - breaking-change - title: Exciting New Features 🎉 labels: - - enhancement + - new-feature - title: Other Changes labels: - "*" From aae0ed7ea1367b16fc7ad9ad93abd4a2271e829f 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 12:38:00 -0300 Subject: [PATCH 3/4] chore: change the release categories --- .github/PULL_REQUEST_TEMPLATE.md | 3 +-- .github/release.yml | 27 +++++++++++++++++++++++---- 2 files changed, 24 insertions(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9e25a1b9..66b81907 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,6 +6,5 @@ Fixes # ### Reviewer Checklist - [ ] New features are tested and documented -- [ ] If PR introduces breaking changes, it is labeled with `breaking-change` -- [ ] If PR introduces new features, it is labeled with `new-feature` +- [ ] 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 index 5f45c0f2..88b18d1b 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -3,12 +3,31 @@ changelog: labels: - ignore-for-release categories: - - title: Breaking Changes 🛠 + # vulnerabilities + - title: Security labels: - - breaking-change - - title: Exciting New Features 🎉 + - changelog-security + # new features + - title: Added labels: - - new-feature + - 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: - "*" From 7420255902ec5994fac83a7fb7734ebcfc5bbdc2 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 12:41:39 -0300 Subject: [PATCH 4/4] docs: add emojis to each category --- .github/release.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/release.yml b/.github/release.yml index 88b18d1b..2a9ae979 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -4,27 +4,27 @@ changelog: - ignore-for-release categories: # vulnerabilities - - title: Security + - title: Security 🔒 labels: - changelog-security # new features - - title: Added + - title: Added 🎉 labels: - changelog-added # changes in existing functionality - - title: Changed + - title: Changed 🛠 labels: - changelog-changed # soon-to-be removed features - - title: Deprecated + - title: Deprecated ⚠️ labels: - changelog-deprecated # now removed features - - title: Removed + - title: Removed 🗑 labels: - changelog-removed # documentation was added or changed - - title: Documentation + - title: Documentation 📚 labels: - changelog-documentation