Skip to content

Commit

Permalink
[changelog skip] Ensure PRs include a Changelog entry
Browse files Browse the repository at this point in the history
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!
  • Loading branch information
schneems committed Sep 27, 2019
1 parent 700a948 commit 7608b49
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .github/workflows/check_changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Check Changelog

on: [pull_request]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Check that CHANGELOG is touched
run: |
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 comments on commit 7608b49

Please sign in to comment.