-
-
Notifications
You must be signed in to change notification settings - Fork 196
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Github workflow to check for changelog entry
When creating PR we should update the changelog as this helps others see what is upcoming in the next release and makes release Alaveteli versions easier. This workflow ensures an `docs/CHANGES.md` is modified or the pull request description contains `[skip changelog]` Update the PR template to help remind devs to do this before the PR is created.
- Loading branch information
Showing
2 changed files
with
56 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
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,52 @@ | ||
name: Changelog | ||
|
||
on: | ||
pull_request: | ||
types: | ||
- opened | ||
- synchronize | ||
- reopened | ||
- edited | ||
|
||
jobs: | ||
check: | ||
runs-on: ubuntu-latest | ||
continue-on-error: true | ||
|
||
env: | ||
GH_TOKEN: ${{ github.token }} | ||
|
||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v3 | ||
|
||
- name: Check for [skip changelog] | ||
id: skip | ||
run: | | ||
PR_DESCRIPTION=$(gh pr view https://github.com/${{ github.repository }}/pull/${{ github.event.pull_request.number }} --json body -q '.body') | ||
if echo "$PR_DESCRIPTION" | grep -q "\[skip changelog\]"; then | ||
echo "skip_changelog=true" >> $GITHUB_OUTPUT | ||
else | ||
echo "skip_changelog=false" >> $GITHUB_OUTPUT | ||
fi | ||
- name: Check for changes in doc/CHANGES.md | ||
id: changes | ||
run: | | ||
git fetch origin ${{ github.event.pull_request.base.ref }} | ||
FILES_CHANGED=$(git diff --name-only origin/${{ github.event.pull_request.base.ref }} ${{ github.sha }}) | ||
if [[ "$FILES_CHANGED" == *"doc/CHANGES.md"* ]]; then | ||
echo "changes_found=true" >> $GITHUB_OUTPUT | ||
else | ||
echo "changes_found=false" >> $GITHUB_OUTPUT | ||
fi | ||
- name: Final Check | ||
run: | | ||
if [[ "${{ steps.skip.outputs.skip_changelog }}" == "true" || "${{ steps.changes.outputs.changes_found }}" == "true" ]]; then | ||
echo "Either [skip changelog] was found or doc/CHANGES.md was modified. Passing the action." | ||
exit 0 | ||
else | ||
echo "Neither [skip changelog] was found nor was doc/CHANGES.md modified. Failing the action." | ||
exit 1 | ||
fi |