From 2b9d4d62a60366318a6bb87edc8156bcf445557b Mon Sep 17 00:00:00 2001
From: Tim Jacomb <21194782+timja@users.noreply.github.com>
Date: Sun, 16 Feb 2025 10:31:42 +0000
Subject: [PATCH] Require a changelog label (#10273)

---
 .github/PULL_REQUEST_TEMPLATE.md              | 29 +++++++++++++++++
 .github/workflows/require-changelog-label.yml | 31 +++++++++++++++++++
 2 files changed, 60 insertions(+)
 create mode 100644 .github/workflows/require-changelog-label.yml

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index a2ed88450d..c937a5df64 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -42,6 +42,35 @@ You may add multiple changelog entries if applicable by adding a new entry to th
 - Second changelog entry
 -->
 
+### Proposed changelog category
+
+/label <update-this-with-category>
+
+<!--
+The changelog entry needs to have a category which is selected based on the label.
+If there's no changelog then the label should be `skip-changelog`.
+
+The available categories are:
+* bug - Minor bug. Will be listed after features
+* developer - Changes which impact plugin developers
+* dependencies - Pull requests that update a dependency
+* internal - Internal only change, not user facing
+* into-lts - Changes that are backported to the LTS baseline
+* localization - Updates localization files
+* major-bug - Major bug. Will be highlighted on the top of the changelog
+* major-rfe - Major enhancement. Will be highlighted on the top
+* rfe - Minor enhancement
+* regression-fix - Fixes a regression in one of the previous Jenkins releases
+* removed - Removes a feature or a public API
+* skip-changelog - Should not be shown in the changelog
+
+Non-changelog categories:
+* web-ui - Changes in the web UI
+
+Non-changelog categories require a changelog category but should be used if applicable,
+comma separate to provide multiple categories in the label command.
+-->
+
 ### Proposed upgrade guidelines
 
 N/A
diff --git a/.github/workflows/require-changelog-label.yml b/.github/workflows/require-changelog-label.yml
new file mode 100644
index 0000000000..457d9f3e60
--- /dev/null
+++ b/.github/workflows/require-changelog-label.yml
@@ -0,0 +1,31 @@
+name: Require Changelog Label
+on:
+  pull_request_target:
+    types: [opened, labeled, unlabeled, synchronize]
+    branches:
+      - 'master'
+jobs:
+  label:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: mheap/github-action-required-labels@388fd6af37b34cdfe5a23b37060e763217e58b03 # v5
+        with:
+          mode: minimum
+          count: 1
+          add_comment: true
+          message: "Missing required label for changelog. Requires {{errorString}} {{count}} of: {{ provided }}. Found: {{ applied }}.\n\nYou can add the required label by adding a comment with the following text: `/label <category>`"
+          labels: |
+            bug
+            developer
+            dependencies
+            internal
+            localization
+            major-bug
+            major-rfe
+            rfe
+            regression-fix
+            removed
+            skip-changelog