From 3fa23b667f4cb391b1d1340d823cd9a62aafbe0c Mon Sep 17 00:00:00 2001 From: Matthew Thompson Date: Mon, 26 Feb 2024 10:02:48 -0500 Subject: [PATCH] Add changelog enforcer --- .github/workflows/changelog-enforcer.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/workflows/changelog-enforcer.yml diff --git a/.github/workflows/changelog-enforcer.yml b/.github/workflows/changelog-enforcer.yml new file mode 100644 index 0000000..7a02fd2 --- /dev/null +++ b/.github/workflows/changelog-enforcer.yml @@ -0,0 +1,22 @@ +name: "Enforce Changelog" +on: + pull_request: + types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled] + +jobs: + # Enforces the update of a changelog file on every pull request + changelog: + runs-on: ubuntu-latest + steps: + - uses: dangoslen/changelog-enforcer@v3 + with: + changeLogPath: 'ChangeLog.md' + skipLabels: 'Skip Changelog' + missingUpdateErrorMessage: > + No update to ChangeLog.md found! Please add a changelog + entry to it describing your change. Please note that the + keepachangelog (https://keepachangelog.com) format is + used. If your change is very trivial not applicable for a + changelog entry, add a 'Skip Changelog' label to the pull + request to skip the changelog enforcer. +