Skip to content

Commit

Permalink
Enforces CHANGELOG entries on PRs
Browse files Browse the repository at this point in the history
GitHub workflow that verifies if CHANGELOG 'changes' are part of the PR.
  • Loading branch information
luislavena committed Jul 20, 2024
1 parent b1bb661 commit 4fc6f2d
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .changes/unreleased/internal-20240720-181428.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
kind: internal
body: Enforces CHANGELOG entries on PRs
time: 2024-07-20T18:14:28.964448+02:00
custom:
Issue: ""
25 changes: 25 additions & 0 deletions .github/workflows/check-changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Require CHANGELOG entry

on:
pull_request:
types:
# On by default if you specify no types.
- "opened"
- "reopened"
- "synchronize"
# For `skip-label` only.
- "labeled"
- "unlabeled"

jobs:
check-changelog:
runs-on: ubuntu-latest
steps:
- name: "Check for changelog entry"
uses: brettcannon/check-for-changed-files@v1
with:
file-pattern: |
.changes/unreleased/*.yaml
CHANGELOG.md
skip-label: "skip changelog"
failure-message: "Missing a changelog file in ${file-pattern}; please add one or apply the ${skip-label} label to the pull request"

0 comments on commit 4fc6f2d

Please sign in to comment.