required-checks.yml

name: Required Checks

# This workflow demonstrates required checks at three stages of the merge lifecycle:
#
#   (A) push        — runs whenever commits are pushed to any branch.
#                     Configure as a required status check on the base branch so that
#                     a branch must pass this check before a PR can be enqueued.
#
#   (B) pull_request — runs when a PR is opened or updated.
#                     Configure as a required status check on the base branch so that
#                     the PR must pass this check before it can be enqueued.
#
#   (C) merge_group  — runs after a PR enters the merge queue, but before it is
#                     merged.  If this check fails the PR is dequeued and the merge
#                     is blocked.
#
# Pass/fail is controlled by the `checks` file in the repository root.
# Each check looks for its own token in that file:
#   push check      → looks for the word  "push"
#   PR check        → looks for the word  "pr"
#   merge-queue check → looks for the word "merge_queue"
#
# To make a check pass, ensure its token is present in the `checks` file.
# To make a check fail, remove its token from the `checks` file.

on:
  push:
  pull_request:
  merge_group:

permissions:
  contents: read

jobs:
  # -----------------------------------------------------------------------
  # (A) Push check
  # Passes when the word "push" appears in the `checks` file.
  # Runs on every push.  Add "Push Check" as a required status check in your
  # branch-protection rule to block enqueuing until this check passes.
  # -----------------------------------------------------------------------
  push-check:
    name: Push Check
    if: github.event_name == 'push'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run push check
        run: |
          if grep -qw "push" checks; then
            echo "Push check passed ('push' found in checks file)"
          else
            echo "Push check failed ('push' not found in checks file)"
            exit 1
          fi

  # -----------------------------------------------------------------------
  # (B) Pull-request check
  # Passes when the word "pr" appears in the `checks` file.
  # Runs when a PR is opened or updated.  Add "PR Check" as a required status
  # check in your branch-protection rule to block enqueuing until this passes.
  # -----------------------------------------------------------------------
  pr-check:
    name: PR Check
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run PR check
        run: |
          if grep -qw "pr" checks; then
            echo "PR check passed ('pr' found in checks file)"
          else
            echo "PR check failed ('pr' not found in checks file)"
            exit 1
          fi

  # -----------------------------------------------------------------------
  # (C) Merge-queue check
  # Passes when the word "merge_queue" appears in the `checks` file.
  # Runs after the PR is added to the merge queue (merge_group event).
  # Add "Merge Queue Check" as a required merge-queue check in your
  # branch-protection rule.  If this check fails the PR is removed from the
  # queue and the merge is blocked.
  # -----------------------------------------------------------------------
  merge-queue-check:
    name: Merge Queue Check
    if: github.event_name == 'merge_group'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run merge-queue check
        run: |
          if grep -qw "merge_queue" checks; then
            echo "Merge queue check passed ('merge_queue' found in checks file)"
          else
            echo "Merge queue check failed ('merge_queue' not found in checks file)"
            exit 1
          fi