Test Health

Look up test health by name and manage the flaky-test quarantine.

Learn more: Test quarantine

mergify tests show #

Look up tests by name and print their health and metrics. Search Test Engine for one or more tests (by exact name or glob) and report their flakiness, failure rate, and recent history. Pass --json for machine-readable output.

Usage 
mergify tests show [OPTIONS] <NAME>...
Arguments
<NAME>... string required repeatable

Test name(s) to look up. Glob patterns (*, ?) are supported by the API

Options
-r, --repository <REPOSITORY> string

Repository full name (owner/repo). Detected from the CI environment or the local git remote when omitted

-t, --token <TOKEN> string

Mergify token. Falls back to MERGIFY_TOKEN, then the credential mergify auth login stored for this API URL, then GITHUB_TOKEN and gh auth token — the last two are deprecated for the Mergify API. Needs an admin application key or a user credential (mergify auth login or a GitHub PAT): a ci key is answered with 403

-u, --api-url <API_URL> string

Mergify API URL. Falls back to MERGIFY_API_URL env var, then to the default

--pipeline-name <PIPELINE_NAME> string

Restrict matches to the given pipeline name(s)

--pipeline-name-exclude <PIPELINE_NAME_EXCLUDE> string

Exclude matches from the given pipeline name(s)

--job-name <JOB_NAME> string

Restrict matches to the given job name(s)

--job-name-exclude <JOB_NAME_EXCLUDE> string

Exclude matches from the given job name(s)

--per-page <PER_PAGE> string

Maximum number of identities the search endpoint may return per page (1–100, server default is 10)

--json flag

Emit a single JSON document to stdout instead of human prose

Global options
-v, --verbose flag

Increase log verbosity: -v info, -vv debug, -vvv trace. Logs go to stderr so stdout stays clean for piping. RUST_LOG overrides this

--debug flag

Shorthand for at least debug-level logging (like -vv)

--color <COLOR> auto | always | never

When to use color in terminal output

Values: auto always never

Default: auto

mergify tests runs #

List a commit's test runs, by the job they arrived under. List the test runs Mergify received for a commit, one line per job name they arrived under: how many arrived whole, from which framework, through a plugin or a converted report. Compare with the jobs your CI runs: a job missing here sent nothing Mergify received. Reads the commit under test by default, or the one --sha, --pr or --branch names.

Usage 
mergify tests runs [OPTIONS]
Options
-r, --repository <REPOSITORY> string

Repository full name (owner/repo). Detected from the CI environment or the local git remote when omitted

--sha <SHA> string

Full SHA of the commit to read. Defaults to the commit under test: in CI, the one test results are uploaded for; elsewhere, HEAD

--pr <NUMBER> string

Read the head commit of this pull request, as the origin remote has it

--branch <BRANCH> string

Read the commit this branch points to on the origin remote

-t, --token <TOKEN> string

Mergify token. Falls back to MERGIFY_TOKEN, then the credential mergify auth login stored for this API URL, then GITHUB_TOKEN and gh auth token — the last two are deprecated for the Mergify API. A user credential or any application key, ci included

-u, --api-url <API_URL> string

Mergify API URL. Falls back to MERGIFY_API_URL env var, then to the default

--json flag

Emit a single JSON document to stdout instead of human prose

Global options
-v, --verbose flag

Increase log verbosity: -v info, -vv debug, -vvv trace. Logs go to stderr so stdout stays clean for piping. RUST_LOG overrides this

--debug flag

Shorthand for at least debug-level logging (like -vv)

--color <COLOR> auto | always | never

When to use color in terminal output

Values: auto always never

Default: auto

mergify tests quarantines add #

Add a test to the Test Engine quarantine. Quarantine a test by its fully qualified name so its failures stop blocking the merge queue. A reason is required; scope it to a branch with --branch, or quarantine on all branches by default.

Usage 
mergify tests quarantines add [OPTIONS] --reason <REASON> <NAME>
Arguments
<NAME> string required

Fully qualified name of the test to quarantine

Options
-r, --repository <REPOSITORY> string

Repository full name (owner/repo). Detected from the CI environment or the local git remote when omitted

--reason <REASON> string required

Reason recorded for quarantining the test

-b, --branch <BRANCH> string

Branch name or pattern to scope the quarantine to. Omit to quarantine on all branches

-t, --token <TOKEN> string

Mergify token. Falls back to MERGIFY_TOKEN, then the credential mergify auth login stored for this API URL, then GITHUB_TOKEN and gh auth token — the last two are deprecated for the Mergify API. Needs an admin application key or a user credential (mergify auth login or a GitHub PAT): a ci key is answered with 403

-u, --api-url <API_URL> string

Mergify API URL. Falls back to MERGIFY_API_URL env var, then to the default

--json flag

Emit a single JSON document to stdout instead of human prose

Global options
-v, --verbose flag

Increase log verbosity: -v info, -vv debug, -vvv trace. Logs go to stderr so stdout stays clean for piping. RUST_LOG overrides this

--debug flag

Shorthand for at least debug-level logging (like -vv)

--color <COLOR> auto | always | never

When to use color in terminal output

Values: auto always never

Default: auto

mergify tests quarantines remove #

Remove a test from the Test Engine quarantine. Take a test out of the quarantine so its results count again. Identify it by test name or by quarantine id.

Usage 
mergify tests quarantines remove [OPTIONS] <NAME_OR_ID>
Arguments
<NAME_OR_ID> string required

Test to remove from quarantine: either its fully qualified name or the quarantine id (as printed by tests quarantines add)

Options
-r, --repository <REPOSITORY> string

Repository full name (owner/repo). Detected from the CI environment or the local git remote when omitted

-t, --token <TOKEN> string

Mergify token. Falls back to MERGIFY_TOKEN, then the credential mergify auth login stored for this API URL, then GITHUB_TOKEN and gh auth token — the last two are deprecated for the Mergify API. Needs an admin application key or a user credential (mergify auth login or a GitHub PAT): a ci key is answered with 403

-u, --api-url <API_URL> string

Mergify API URL. Falls back to MERGIFY_API_URL env var, then to the default

--json flag

Emit a single JSON document to stdout instead of human prose

Global options
-v, --verbose flag

Increase log verbosity: -v info, -vv debug, -vvv trace. Logs go to stderr so stdout stays clean for piping. RUST_LOG overrides this

--debug flag

Shorthand for at least debug-level logging (like -vv)

--color <COLOR> auto | always | never

When to use color in terminal output

Values: auto always never

Default: auto

mergify tests quarantines get #

Print a single quarantine by test name or id. Show the details of one quarantined test — its reason, branch scope, and when it was added. Identify it by test name or by quarantine id.

Usage 
mergify tests quarantines get [OPTIONS] <NAME_OR_ID>
Arguments
<NAME_OR_ID> string required

Quarantine to print: either the test's fully qualified name or the quarantine id (as printed by tests quarantines add)

Options
-r, --repository <REPOSITORY> string

Repository full name (owner/repo). Detected from the CI environment or the local git remote when omitted

-t, --token <TOKEN> string

Mergify token. Falls back to MERGIFY_TOKEN, then the credential mergify auth login stored for this API URL, then GITHUB_TOKEN and gh auth token — the last two are deprecated for the Mergify API

-u, --api-url <API_URL> string

Mergify API URL. Falls back to MERGIFY_API_URL env var, then to the default

--json flag

Emit a single JSON document to stdout instead of human prose

Global options
-v, --verbose flag

Increase log verbosity: -v info, -vv debug, -vvv trace. Logs go to stderr so stdout stays clean for piping. RUST_LOG overrides this

--debug flag

Shorthand for at least debug-level logging (like -vv)

--color <COLOR> auto | always | never

When to use color in terminal output

Values: auto always never

Default: auto

mergify tests quarantines list #

List the tests currently in the Test Engine quarantine. Print every test currently held in the quarantine for the repository. Pass --json for machine-readable output.

Usage 
mergify tests quarantines list [OPTIONS]
Options
-r, --repository <REPOSITORY> string

Repository full name (owner/repo). Detected from the CI environment or the local git remote when omitted

-t, --token <TOKEN> string

Mergify token. Falls back to MERGIFY_TOKEN, then the credential mergify auth login stored for this API URL, then GITHUB_TOKEN and gh auth token — the last two are deprecated for the Mergify API

-u, --api-url <API_URL> string

Mergify API URL. Falls back to MERGIFY_API_URL env var, then to the default

--json flag

Emit a single JSON document to stdout instead of human prose

Global options
-v, --verbose flag

Increase log verbosity: -v info, -vv debug, -vvv trace. Logs go to stderr so stdout stays clean for piping. RUST_LOG overrides this

--debug flag

Shorthand for at least debug-level logging (like -vv)

--color <COLOR> auto | always | never

When to use color in terminal output

Values: auto always never

Default: auto

Was this page helpful?