actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use a better merge-queue success check.

This commit is contained in:
Eric Huss 2023-07-29 09:13:55 -07:00
parent 429ca06289
commit 9340e6a78d
1 changed files with 9 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
.github/workflows/main.yml vendored
View File

@ -48,42 +48,19 @@ jobs:
run: rustup update stable && rustup default stable && rustup component add rustfmt run: rustup update stable && rustup default stable && rustup component add rustfmt
- run: cargo fmt --check - run: cargo fmt --check
# These success/failure jobs are here to consolidate the total # The success job is here to consolidate the total success/failure state of
# success/failure state of all other jobs. These jobs are then included in # all other jobs. This job is then included in the GitHub branch protection
# the GitHub branch protection rule which prevents merges unless all other # rule which prevents merges unless all other jobs are passing. This makes
# jobs are passing. This makes it easier to manage the list of jobs via this # it easier to manage the list of jobs via this yml file and to prevent
# yml file and to prevent accidentally adding new jobs without also updating # accidentally adding new jobs without also updating the branch protections.
# the branch protections.
#
# Unfortunately this requires two jobs because the branch protection
# considers skipped jobs as successful. The status check functions like
# success() can only be in an `if` condition.
#
# Beware that success() is false if any dependent job is skipped. See
# https://github.com/orgs/community/discussions/45058. This means there
# cannot be optional jobs. One workaround is to check for all other
# statuses:
# (contains(needs.*.result, 'cancelled') || contains(needs.*.result, 'skipped') || contains(needs.*.result, 'failure'))
# but that is a mess.
success: success:
name: Success gate name: Success gate
runs-on: ubuntu-latest if: always()
needs: needs:
- test - test
- rustfmt - rustfmt
if: "success()"
steps:
- name: mark the job as a success
run: echo success
failure:
name: Failure gate
runs-on: ubuntu-latest runs-on: ubuntu-latest
needs:
- test
- rustfmt
if: "!success()"
steps: steps:
- name: mark the job as a failure - run: jq --exit-status 'all(.result == "success")' <<< '${{ toJson(needs) }}'
run: | - name: Done
echo One or more jobs failed run: exit 0
exit 1