summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.github/workflows/require-changelog-for-PRs.yml26
-rw-r--r--CHANGELOG.md1
2 files changed, 27 insertions, 0 deletions
diff --git a/.github/workflows/require-changelog-for-PRs.yml b/.github/workflows/require-changelog-for-PRs.yml
new file mode 100644
index 00000000..518fa9d5
--- /dev/null
+++ b/.github/workflows/require-changelog-for-PRs.yml
@@ -0,0 +1,26 @@
+name: Changelog
+
+on:
+ pull_request:
+
+jobs:
+ check-changelog:
+ name: Check for changelog entry
+ runs-on: ubuntu-latest
+ # dependabot PRs are automerged if CI passes; we shouldn't block these
+ if: github.actor != 'dependabot[bot]'
+ env:
+ PR_SUBMITTER: ${{ github.actor }}
+ PR_NUMBER: ${{ github.event.number }}
+ PR_BASE: ${{ github.base_ref }}
+ steps:
+ - uses: actions/checkout@v4
+ - name: Fetch PR base
+ run: git fetch --no-tags --prune --depth=1 origin
+ - name: Search for added line in changelog
+ run: |
+ ADDED=$(git diff -U0 "origin/${PR_BASE}" HEAD -- CHANGELOG.md | grep -P '^\+[^\+].+$')
+ echo "Added lines in CHANGELOG.md:"
+ echo "$ADDED"
+ echo "Grepping for PR info:"
+ grep "#${PR_NUMBER}\\b.*@${PR_SUBMITTER}\\b" <<< "$ADDED"
diff --git a/CHANGELOG.md b/CHANGELOG.md
index d63e98a9..d12cb8fe 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,7 @@
- Upgrade to Rust 2021 edition #2748 (@cyqsimon)
- Refactor and cleanup build script #2756 (@cyqsimon)
+- Checks changelog has been written to for PRs in CI #2766 (@cyqsimon)
## Syntaxes