From 9340e6a78d1f43b9a1295f1ca2848c7ab5f2fb07 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Sat, 29 Jul 2023 09:13:55 -0700 Subject: [PATCH] Use a better merge-queue success check. --- .github/workflows/main.yml | 41 +++++++++----------------------------- 1 file changed, 9 insertions(+), 32 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 1e7351dd..d6a1b9ca 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -48,42 +48,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