Skip to content

Commit

Permalink
Require a changelog label
Browse files Browse the repository at this point in the history
  • Loading branch information
timja committed Feb 15, 2025
1 parent 058e0a8 commit 390e433
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,34 @@ 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
* 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
Expand Down
27 changes: 27 additions & 0 deletions .github/workflows/require-changelog-label.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Require Changelog Label
on:
pull_request:
types: [opened, labeled, unlabeled, synchronize]
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
labels: |
bug
developer
dependencies
internal
localization
major-bug
major-rfe
rfe
regression-fix
removed

0 comments on commit 390e433

Please sign in to comment.