-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add workflow to check for presence of CHANGELOG changes on PRs (#1067)
- Loading branch information
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# This action requires that any PR targeting the master branch should touch at | ||
# least one CHANGELOG file. If a CHANGELOG entry is not required, add the "Skip | ||
# Changelog" label to disable this action. | ||
|
||
name: changelog | ||
|
||
on: | ||
pull_request: | ||
types: [opened, synchronize, reopened, labeled, unlabeled] | ||
branches: | ||
- master | ||
|
||
jobs: | ||
changelog: | ||
runs-on: ubuntu-latest | ||
if: "!contains(github.event.pull_request.labels.*.name, 'Skip Changelog')" | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
- name: Check for CHANGELOG changes | ||
run: | | ||
# Only the latest commit of the feature branch is available | ||
# automatically. To diff with the base branch, we need to | ||
# fetch that too (and we only need its latest commit). | ||
git fetch origin ${{ github.base_ref }} --depth=1 | ||
if [[ $(git diff --name-only FETCH_HEAD | grep CHANGELOG) ]] | ||
then | ||
echo "A CHANGELOG was modified. Looks good!" | ||
else | ||
echo "No CHANGELOG was modified." | ||
echo "Please add a CHANGELOG entry, or add the \"Skip Changelog\" label if not required." | ||
false | ||
fi |