Merge pull request #2140 from ehuss/merge-queue-workflow

Prepare CI workflows to support merge queues.
This commit is contained in:
Eric Huss 2023-07-24 20:35:16 -07:00 committed by GitHub
commit 429ca06289
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 2 deletions

View File

@ -1,7 +1,5 @@
name: CI name: CI
on: on:
push:
branches-ignore: [master]
pull_request: pull_request:
merge_group: merge_group:
@ -49,3 +47,43 @@ jobs:
- name: Install Rust - name: Install Rust
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
# 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.
success:
name: Success gate
runs-on: ubuntu-latest
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