Skip to content

Commit 3fef7ca

Browse files
committed
[changelog skip] Ensure PRs include a Changelog entry
The goal of this PR is to add a github action that checks for the presence of a changelog entry. It is better to add entries as a PR is merged instead of having to remember what was merged and generate a changelog at release time. By automating this check, it's one less thing the maintainer has to remember, and it's one less thing a change might be blocked on i.e. "Looks good, but please add a changelog entry". Let me know if you have any questions and Happy Friday!
1 parent ff42f31 commit 3fef7ca

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

.github/workflows/check_changelog.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Check Changelog
2+
3+
on: [pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v1
10+
- name: Check that CHANGELOG is touched
11+
run: |
12+
cat $GITHUB_EVENT_PATH | jq .pull_request.title | grep -i '[((changelog skip)|(ci skip))]' || git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md

0 commit comments

Comments
 (0)