-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CI: check the presence of the changelog line in every pull request
Checking it only in the merge queue leads to deferred failures once the decision to merge has been taken already.
- Loading branch information
1 parent
197d58d
commit 1a4376b
Showing
2 changed files
with
57 additions
and
33 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,56 @@ | ||
name: Clippy changelog check | ||
|
||
on: | ||
pull_request: | ||
types: [opened, reopened, edited] | ||
|
||
concurrency: | ||
# For a given workflow, if we push to the same PR, cancel all previous builds on that PR. | ||
# If the push is not attached to a PR, we will cancel all builds on the same branch. | ||
group: "${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}" | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
changelog: | ||
runs-on: ubuntu-latest | ||
|
||
defaults: | ||
run: | ||
shell: bash | ||
|
||
steps: | ||
# Run | ||
- name: Check Changelog | ||
run: | | ||
body=$(curl -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" -s "https://api.github.com/repos/rust-lang/rust-clippy/pulls/$PR_NUMBER" | \ | ||
python -c "import sys, json; print(json.load(sys.stdin)['body'])") | ||
output=$(grep "^changelog:\s*\S" <<< "$body" | sed "s/changelog:\s*//g") || { | ||
echo "ERROR: pull request message must contain 'changelog: ...'. Add it " \ | ||
"and push (or force-push) the pull request to trigger a new check." | ||
exit 1 | ||
} | ||
echo "changelog: $output" | ||
env: | ||
PYTHONIOENCODING: 'utf-8' | ||
PR_NUMBER: '${{ github.event.number }}' | ||
|
||
# We need to have the "conclusion" job also on PR CI, to make it possible | ||
# to add PRs to a merge queue. | ||
conclusion_changelog: | ||
needs: [ changelog ] | ||
# We need to ensure this job does *not* get skipped if its dependencies fail, | ||
# because a skipped job is considered a success by GitHub. So we have to | ||
# overwrite `if:`. We use `!cancelled()` to ensure the job does still not get run | ||
# when the workflow is canceled manually. | ||
# | ||
# ALL THE PREVIOUS JOBS NEED TO BE ADDED TO THE `needs` SECTION OF THIS JOB! | ||
if: ${{ !cancelled() }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
# Manually check the status of all dependencies. `if: failure()` does not work. | ||
- name: Conclusion | ||
run: | | ||
# Print the dependent jobs to see them in the CI log | ||
jq -C <<< '${{ toJson(needs) }}' | ||
# Check if all jobs that we depend on (in the needs array) were successful. | ||
jq --exit-status 'all(.result == "success")' <<< '${{ toJson(needs) }}' |