Skip to content

Commit

Permalink
Merge pull request #975 from ehuss/fix-merge-queue
Browse files Browse the repository at this point in the history
Use a better merge-queue success check.
  • Loading branch information
ehuss authored Jul 29, 2023
2 parents 337c404 + fb53225 commit 0c2a4ea
Showing 1 changed file with 9 additions and 32 deletions.
41 changes: 9 additions & 32 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,42 +45,19 @@ jobs:
run: rustup update stable && rustup default stable && rustup component add rustfmt
- run: cargo fmt -- --check

# These success/failure jobs are here to consolidate the total
# success/failure state of all other jobs. These jobs are then included in
# the GitHub branch protection rule which prevents merges unless all other
# jobs are passing. This makes it easier to manage the list of jobs via this
# yml file and to prevent accidentally adding new jobs without also updating
# 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.
# The success job is here to consolidate the total success/failure state of
# all other jobs. This job is then included in the GitHub branch protection
# rule which prevents merges unless all other jobs are passing. This makes
# it easier to manage the list of jobs via this yml file and to prevent
# accidentally adding new jobs without also updating the branch protections.
success:
name: Success gate
runs-on: ubuntu-latest
if: always()
needs:
- test
- rustfmt
if: "success()"
steps:
- name: mark the job as a success
run: echo success
failure:
name: Failure gate
runs-on: ubuntu-latest
needs:
- test
- rustfmt
if: "!success()"
steps:
- name: mark the job as a failure
run: |
echo One or more jobs failed
exit 1
- run: jq --exit-status 'all(.result == "success")' <<< '${{ toJson(needs) }}'
- name: Done
run: exit 0

0 comments on commit 0c2a4ea

Please sign in to comment.