From 3fef7caf500b2b945827affd7cac704590d61946 Mon Sep 17 00:00:00 2001 From: schneems Date: Fri, 27 Sep 2019 16:09:19 -0500 Subject: [PATCH] [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! --- .github/workflows/check_changelog.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 .github/workflows/check_changelog.yml diff --git a/.github/workflows/check_changelog.yml b/.github/workflows/check_changelog.yml new file mode 100644 index 0000000..8c8dfcc --- /dev/null +++ b/.github/workflows/check_changelog.yml @@ -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