SuperAPI AI Directory
Partner with us中文AI newsFavorites
Skillsmergify-ci

mergify-ci

Data & analytics

View repository

Updated 10-16 00:29

About this skill

Mergify CI Commands

Overview

The mergify ci command group provides tools for CI pipelines: uploading JUnit test results to Mergify CI Insights, detecting git references for diff-based operations, managing CI scopes for selective testing, and retrieving merge queue batch metadata.

Commands

mergify ci junit-process FILES...         # Upload JUnit XML + evaluate quarantine (primary command)
mergify ci junit-upload FILES...          # (Deprecated) Use junit-process instead
mergify ci git-refs                       # Detect base/head git references for the current PR
mergify ci scopes --config PATH           # Detect scopes impacted by changed files
mergify ci scopes-send -s SCOPE           # Report scopes against the pull request's head commit
mergify ci queue-info                     # Output the current build's merge queue batch metadata (from the git note)
mergify tests show NAME...                # Look up tests by name and print health, ratios, last failure
mergify tests quarantines add NAME        # Add a test to the CI Insights quarantine
mergify tests quarantines remove NAME     # Remove a test from the CI Insights quarantine
mergify tests quarantines get NAME        # Print a single quarantine by test name or id
mergify tests quarantines list            # List the tests currently in the CI Insights quarantine

Authentication

Two classes of Mergify application key, both minted in the dashboard. Each reaches its own list of endpoints, not a subset of the other's: of what this CLI calls, the two lists share only the quarantine list.

Key Reaches
ci What a CI job does: trace upload, scopes-send, quarantine evaluation (junit-process) and the quarantine list.
admin Reading test health, the quarantine list, and mutating the quarantine. Not trace upload, not scopes-send.

Trace upload and scopes-send take a ci key only: an admin key or a GitHub PAT gets a 403. Every other endpoint below that refuses a ci key accepts a GitHub PAT instead. GITHUB_TOKEN inside GitHub Actions is not a PAT — it is the ephemeral installation token — so do not reach for it to clear one of these 403s.

The split follows the endpoint each command calls: reads of test health and writes to the quarantine are a person inspecting or overriding a repository, not something a pipeline does, so they are outside what a ci key carries; trace upload and scope reports are what a pipeline sends, so they are outside what an admin key carries. Per command:

Command ci key admin key
ci junit-process, ci junit-upload yes quarantine evaluation only — the upload gets a 403, reported as a rejected upload (the exit code is unaffected)
ci scopes-send yes no — 403
tests quarantines list, tests quarantines get yes — both read the quarantine list yes
tests show no — 403 yes
tests quarantines add, tests quarantines remove no — 403 yes

ci git-refs, ci scopes and ci queue-info are evaluated locally and need no token at all.

JUnit Processing (junit-process)

The primary CI command. Parses JUnit XML reports, checks quarantine status for failing tests, uploads results to Mergify CI Insights, and determines the final CI exit code.

mergify ci junit-process \
  --token "$MERGIFY_TOKEN" \
  --repository owner/repo \
  --tests-target-branch main \
  path/to/junit-results.xml

FILES can be individual paths or quoted glob patterns (e.g. 'reports/**/*.xml'). Always quote the pattern so Mergify expands it rather than the shell — this is the recommended approach for large, sharded test suites.

Key options:

  • --token / -t (env: MERGIFY_TOKEN) -- CI Insights application key
  • --repository / -r -- Repository full name (auto-detected from the CI provider, then the git remote)
  • --tests-target-branch / -ttb -- Branch used for quarantine evaluation. Auto-detected per CI provider: GitHub Actions (GITHUB_BASE_REF → GITHUB_HEAD_REF → GITHUB_REF_NAME), Buildkite (BUILDKITE_PULL_REQUEST_BASE_BRANCH → BUILDKITE_BRANCH), CircleCI (CIRCLE_BRANCH), Jenkins (CHANGE_TARGET → GIT_BRANCH), then the checked-out branch.
  • --api-url / -u (env: MERGIFY_API_URL) -- Mergify API URL (default: https://api.mergify.com)
  • --test-framework -- Test framework name (optional metadata)
  • --test-language -- Test language (optional metadata)
  • --test-exit-code / -e (env: MERGIFY_TEST_EXIT_CODE) -- Exit code of the test runner, used to detect silent failures where the runner crashed but the JUnit report appears clean
  • MERGIFY_TRACEPARENT (env only) -- A W3C traceparent to put the uploaded test session inside a trace the caller already started; a malformed value is ignored and the session starts its own trace

Behavior:

  1. Parses JUnit XML files into test spans
  2. Checks quarantine status for failing tests against the Mergify API
  3. Uploads all test spans to Mergify CI Insights
  4. Prints a summary: tests run, failures, quarantined vs blocking
  5. Exits with code 0 if all failures are quarantined, code 1 if any are blocking
  6. If --test-exit-code is non-zero but no test failures are found, exits with code 1 (silent failure detection)
  7. Upload failures never affect the exit code (Mergify-side trouble must not break CI), but they are surfaced: on GitHub Actions the command emits an ::error:: annotation when the upload is rejected (HTTP 4xx except 408/429, e.g. a token without CI Insights access) or a ::warning:: annotation for transient errors (5xx, 408, 429, network), and appends test_results_upload=success|rejected|failed to $GITHUB_OUTPUT so workflows can detect dead ingest programmatically

GitHub Actions example:

- name: Run tests
  id: tests
  run: pytest --junitxml=results.xml || echo "exit_code=$?" >> "$GITHUB_OUTPUT"

- name: Process test results
  if: always()
  run: |
    mergify ci junit-process \
      --test-exit-code ${{ steps.tests.outputs.exit_code || 0 }} \
      results.xml
  env:
    MERGIFY_TOKEN: ${{ secrets.MERGIFY_TOKEN }}

Git References (git-refs)

Detects the base and head git references for the current pull request context. Writes results to GITHUB_OUTPUT when running in GitHub Actions, and to Buildkite meta-data (mergify-ci.base, mergify-ci.head, mergify-ci.source) when running in Buildkite.

mergify ci git-refs
# Output:
# Base: abc1234
# Head: def5678

Output formats (--format):

  • text (default) — human-readable Base: / Head: lines
  • shell — MERGIFY_GIT_REFS_{BASE,HEAD,SOURCE}=... lines suitable for eval, with POSIX-safe shell quoting. When base can't be detected, MERGIFY_GIT_REFS_BASE=''.
  • json — single-line JSON object with base, head, source keys. base may be null when it can't be detected (e.g., workflow_dispatch events); use jq -r '.base // ""' to coalesce to empty string.
# Consume values in a shell script without parsing:
eval "$(mergify ci git-refs --format=shell)"
nx show projects --affected \
  --base="$MERGIFY_GIT_REFS_BASE" \
  --head="$MERGIFY_GIT_REFS_HEAD"

# Or with jq:
BASE=$(mergify ci git-refs --format=json | jq -r '.base // ""')

Sources detected (in priority order): merge queue context, GitHub pull request event, GitHub push event, fallback to last commit.

Scopes (scopes)

Detects which CI scopes are impacted by changed files, based on a Mergify configuration file. Used for selective/targeted CI -- only run tests for scopes that have changed files.

# Detect scopes from changed files
mergify ci scopes --config .mergify.yml

# Detect scopes with explicit base/head
mergify ci scopes --config .mergify.yml --base origin/main --head HEAD

# Write detected scopes to a file
mergify ci scopes --config .mergify.yml --write scopes.json

Key options:

  • --config (env: MERGIFY_CONFIG_PATH) -- Path to the Mergify YAML config file (auto-detected)
  • --base -- Base git reference (auto-detected)
  • --head -- Head git reference (default: HEAD)
  • --write / -w -- Write detected scopes to a JSON file

The config file defines scopes with file patterns. When files change between base and head, matching scopes are identified and written to GITHUB_OUTPUT (on GitHub Actions) or to Buildkite meta-data under mergify-ci.scopes (on Buildkite), as a JSON map of scope names to "true"/"false".

On a merge queue draft pull request, scopes are not computed from changed files: the command reads the engine's git note for the batch and returns the scopes the merge queue decided (the batch's scopes plus each batched pull request's scopes, including scopes a pull request's CI reported), plus the merge queue scope. A batch the note marks as a barrier (all_scopes: true) selects every scope. This also works with a manual scopes source. Without a note, or with a note that has no scopes list, it falls back to diffing files.

A renamed file counts against both of its paths, same as the engine: git mv critical/guard.txt ignored/guard.txt touches critical and ignored.

Scopes Send (scopes-send)

Sends scopes tied to a pull request to the Mergify API. Used when scopes are determined manually or from a file rather than auto-detected.

The report is addressed by the pull request's head SHA, so it says which revision it was computed for and a result computed for an older head cannot be taken for the current one. The head is detected from the CI environment (GitHub Actions event payload, or BUILDKITE_COMMIT); pass --head-sha to name it explicitly. When no head SHA can be resolved -- or the Mergify deployment predates the commit endpoint -- the command falls back to reporting against the pull request number alone, which is what it always did.

Needs a ci key — an admin key or a GitHub PAT gets a 403. See Authentication.

# Send specific scopes
mergify ci scopes-send -s frontend -s backend -p 123

# Send scopes from a JSON file (produced by `mergify ci scopes --write`)
mergify ci scopes-send --scopes-json scopes.json -p 123

# Send scopes from a plain-text file (one scope per line)
mergify ci scopes-send --scopes-file scopes.txt -p 123

# Declare the PR impacts every scope (merge-queue barrier),
# e.g. a build-system or CI-workflow change
mergify ci scopes-send -s build-system --all -p 123

# Name the revision explicitly (the pull request head, not the
# revision a `pull_request` job checked out)
mergify ci scopes-send -s frontend -p 123 --head-sha "$PR_HEAD_SHA"

Key options:

  • --token / -t (env: MERGIFY_TOKEN) -- Mergify ci application key
  • --repository / -r -- Repository full name (auto-detected)
  • --pull-request / -p -- Pull request number (auto-detected in GitHub Actions)
  • --scope / -s -- Scope name (repeatable)
  • --scopes-json -- JSON file containing scopes (output of mergify ci scopes --write)
  • --scopes-file -- Plain-text file with one scope per line
  • --head-sha -- Head SHA the scopes were computed for, 40 hexadecimal characters (auto-detected from the CI environment)
  • --all -- Declare the pull request impacts every scope. The merge queue treats it as a barrier: never batched or run in parallel with other pull requests. The concrete scopes are still sent alongside the flag.

Tests Show (tests show)

Looks up tests by name on the repository's default branch and prints their health, success/failure ratios, and last failure context. The search is a batch API: pass one or more names (globs supported) and one block per match is rendered. It is read-only: it exits 0 once it has rendered the matches, whatever their health. Gate on health by consuming --json, not the exit code.

Needs an admin key or a GitHub PAT — a ci key gets a 403. See Authentication.

# Single test.
mergify tests show -r owner/repo \
  'ApplicationKeys.spec.ts.Permissions › Should not see keys table if not admin'

# Batch with glob, narrowed to one pipeline, JSON for jq.
mergify tests show -r owner/repo \
  --pipeline-name e2e --json \
  '*test_login*' '*test_logout*' \
  | jq '.tests[] | {test_name, health_status}'

Key options:

  • --repository / -r -- Repository full name (owner/repo); auto-detected from the CI environment or the local git remote when omitted.
  • --token / -t (env: MERGIFY_TOKEN) -- Mergify credential. Falls back to the credential mergify auth login stored, then to GITHUB_TOKEN / gh auth token, both deprecated for the Mergify API.
  • --api-url / -u (env: MERGIFY_API_URL) -- API base URL.
  • --pipeline-name, --pipeline-name-exclude -- Restrict / exclude by pipeline.
  • --job-name, --job-name-exclude -- Restrict / exclude by job.
  • --per-page -- Cap the search result count (1–100, server default 10).
  • --json -- Emit a single JSON document {"tests": [...]} to stdout.

Exit codes:

  • 0 -- Tests rendered, or no match at all. Health does not affect it.
  • 6 -- Mergify API error, including the 403 a ci key gets here.

Tests Quarantines Add (tests quarantines add)

Adds a test to the repository's CI Insights quarantine, so its failures stop blocking the CI verdict. Takes a single fully qualified test name; a --reason is required.

Needs an admin key or a GitHub PAT — a ci key gets a 403. See Authentication.

# Quarantine on all branches.
mergify tests quarantines add -r owner/repo \
  --reason 'flaky — tracked in MRGFY-1234' \
  'test_login'

# Scope the quarantine to one branch (or branch pattern), JSON output.
mergify tests quarantines add -r owner/repo \
  --reason 'broken on release branch' --branch 'release/*' --json \
  'test_logout'

Key options:

  • --repository / -r -- Repository full name (owner/repo); auto-detected from the CI environment or the local git remote when omitted.
  • --reason -- Reason recorded for the quarantine; required.
  • --branch / -b -- Branch name or pattern to scope to. Omit for all branches.
  • --token / -t (env: MERGIFY_TOKEN) -- Mergify credential. Falls back to the credential mergify auth login stored, then to GITHUB_TOKEN / gh auth token, both deprecated for the Mergify API.
  • --api-url / -u (env: MERGIFY_API_URL) -- API base URL.
  • --json -- Emit {"id", "test_name", "reason", "branch"} to stdout.

Exit codes:

  • 0 -- Test quarantined.
  • 6 -- Mergify API error (e.g. the test is already quarantined).

Tests Quarantines Remove (tests quarantines remove)

Removes a test from the quarantine. Accepts either the fully qualified test name (resolved to its quarantine id via the list endpoint) or the quarantine id directly (as printed by tests quarantines add). A UUID-shaped argument is treated as the id and deleted without a lookup.

Needs an admin key or a GitHub PAT — a ci key gets a 403. See Authentication.

# By test name.
mergify tests quarantines remove -r owner/repo 'test_login'

# By quarantine id (the value `tests quarantines add` printed).
mergify tests quarantines remove -r owner/repo 12345678-1234-5678-1234-567812345678

Key options:

  • --repository / -r -- Repository full name (owner/repo); auto-detected from the CI environment or the local git remote when omitted.
  • --token / -t (env: MERGIFY_TOKEN) -- Mergify credential. Falls back to the credential mergify auth login stored, then to GITHUB_TOKEN / gh auth token, both deprecated for the Mergify API.
  • --api-url / -u (env: MERGIFY_API_URL) -- API base URL.
  • --json -- Emit {"id", "test_name"} to stdout (test_name is null when addressed by id).

Exit codes:

  • 0 -- Test unquarantined.
  • 6 -- Mergify API error (e.g. the test is not quarantined).

Tests Quarantines Get (tests quarantines get)

Prints a single quarantine, addressed by the fully qualified test name or the quarantine id (a UUID-shaped argument is matched against the id). The output mirrors one record of tests quarantines list.

# By test name.
mergify tests quarantines get -r owner/repo 'test_login'

# By quarantine id, JSON output.
mergify tests quarantines get -r owner/repo --json \
  12345678-1234-5678-1234-567812345678

Key options:

  • --repository / -r -- Repository full name (owner/repo); auto-detected from the CI environment or the local git remote when omitted.
  • --token / -t (env: MERGIFY_TOKEN) -- Mergify credential. Falls back to the credential mergify auth login stored, then to GITHUB_TOKEN / gh auth token, both deprecated for the Mergify API.
  • --api-url / -u (env: MERGIFY_API_URL) -- API base URL.
  • --json -- Emit the record (id, test_name, reason, branch, created_at, source, is_recovered) to stdout.

Exit codes:

  • 0 -- Quarantine found and printed.
  • 6 -- Mergify API error (e.g. no matching quarantine).

Tests Quarantines List (tests quarantines list)

Lists every test currently in the repository's CI Insights quarantine. Takes no test argument -- it prints the whole quarantine. Human output is one indented block per record -- the test name on its own line (never wrapped mid-name), then its id (the value delete accepts), branch, source, recovered, and reason. --json emits the full records.

# Human output (one block per record).
mergify tests quarantines list -r owner/repo

# JSON for jq -- e.g. names of quarantines an auto-recover run flagged.
mergify tests quarantines list -r owner/repo --json \
  | jq -r '.quarantined_tests[] | select(.is_recovered) | .test_name'

A null branch renders as * (the quarantine applies to all branches). source is manual (added by a user) or auto (added by flaky detection). is_recovered flags quarantines whose recent runs suggest they can be removed.

Key options:

  • --repository / -r -- Repository full name (owner/repo); auto-detected from the CI environment or the local git remote when omitted.
  • --token / -t (env: MERGIFY_TOKEN) -- Mergify credential. Falls back to the credential mergify auth login stored, then to GITHUB_TOKEN / gh auth token, both deprecated for the Mergify API.
  • --api-url / -u (env: MERGIFY_API_URL) -- API base URL.
  • --json -- Emit {"quarantined_tests": [...]} to stdout, each record carrying id, test_name, reason, branch, created_at, source, is_recovered.

Exit codes:

  • 0 -- Always, including an empty quarantine ("No quarantined tests found.").

Queue Info (queue-info)

Outputs the current build's merge queue batch metadata as JSON. Reads the refs/notes/mergify/<branch> git note Mergify writes on the merge queue branch head for the current HEAD; exits INVALID_STATE (7) when no note is found (i.e. not a merge queue batch build). Takes no arguments and needs no GitHub token.

The note's full payload is emitted verbatim (every field Mergify wrote, e.g. checking_base_sha, pull_requests with per-PR scopes, previous_failed_batches, top-level scopes). New fields appear automatically without a CLI update, so don't assume a fixed schema.

# In CI, on a merge queue batch build. Works in any CI (GitHub Actions,
# GitLab, CircleCI, Jenkins, ...) with plain git. When GITHUB_OUTPUT is
# set (GitHub Actions runner) it also writes the metadata there.
mergify ci queue-info

Mergify attaches the batch metadata as a git note to the MQ branch head commit, so reading it needs only git, no PR body and no GitHub token. The command runs git fetch origin "refs/notes/mergify/*" itself (notes aren't fetched by default), then returns the note attached to HEAD. Requirements: the origin remote is reachable and the checkout is at the MQ branch head commit, which is the normal state inside a merge-queue CI run. A detached HEAD is fine.

This command is useful in CI workflows that need to know whether the current run is part of a merge queue batch and what other PRs are in the batch.

Common Patterns

Full CI pipeline with quarantine

jobs:
  test:
    steps:
      - uses: actions/checkout@v4
      - name: Run tests
        run: pytest --junitxml=results.xml
      - name: Upload and evaluate
        if: always()
        run: mergify ci junit-process results.xml
        env:
          MERGIFY_TOKEN: ${{ secrets.MERGIFY_TOKEN }}

Selective testing with scopes

jobs:
  detect:
    outputs:
      scopes: ${{ steps.scopes.outputs.scopes }}
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - id: scopes
        run: mergify ci scopes --config .mergify.yml

  backend:
    needs: detect
    if: fromJSON(needs.detect.outputs.scopes).backend == 'true'
    steps:
      - run: pytest backend/