Skip to content

Commit

Permalink
Add pipeline to enforce updating CHANGELOG.md (#962)
Browse files Browse the repository at this point in the history
As we've been failing to keep this critical documentation up-to-date,
this acts as a strong reminder that it should be updated by failing the
checks on every PR lacking this update.
It includes the exception for the labels "pipelines" and "coverage", as
PRs that only work on those don't introduce user-visible changes.
  • Loading branch information
Oppen committed Apr 12, 2023
1 parent 2ee5e0c commit a1a65fd
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: "Pull Request Workflow"
on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]

jobs:
# Enforces the update of a changelog file on every pull request
# We only want this for user-visible changes, so we add a few labels
# for which the check is skipped
changelog:
runs-on: ubuntu-latest
steps:
- uses: dangoslen/changelog-enforcer@v3
with:
skipLabels: pipelines,coverage

0 comments on commit a1a65fd

Please sign in to comment.