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

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 or GitHub token. Falls back to MERGIFY_TOKEN and then GITHUB_TOKEN env vars

-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
--debug flag

Enable verbose debug logging. Mirrors the Python CLI's top-level --debug flag so the same invocations work against either binary; native commands accept it as a no-op today (no native code path consults it yet), shimmed ones re-inject it into the forwarded argv so the Python side can honor it

mergify tests quarantines add #

Add a test to the CI Insights quarantine

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 or GitHub token. Falls back to MERGIFY_TOKEN and then GITHUB_TOKEN env vars

-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
--debug flag

Enable verbose debug logging. Mirrors the Python CLI's top-level --debug flag so the same invocations work against either binary; native commands accept it as a no-op today (no native code path consults it yet), shimmed ones re-inject it into the forwarded argv so the Python side can honor it

mergify tests quarantines remove #

Remove a test from the CI Insights quarantine

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 or GitHub token. Falls back to MERGIFY_TOKEN and then GITHUB_TOKEN env vars

-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
--debug flag

Enable verbose debug logging. Mirrors the Python CLI's top-level --debug flag so the same invocations work against either binary; native commands accept it as a no-op today (no native code path consults it yet), shimmed ones re-inject it into the forwarded argv so the Python side can honor it

mergify tests quarantines get #

Print a single quarantine by test name or 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 or GitHub token. Falls back to MERGIFY_TOKEN and then GITHUB_TOKEN env vars

-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
--debug flag

Enable verbose debug logging. Mirrors the Python CLI's top-level --debug flag so the same invocations work against either binary; native commands accept it as a no-op today (no native code path consults it yet), shimmed ones re-inject it into the forwarded argv so the Python side can honor it

mergify tests quarantines list #

List the tests currently in the CI Insights quarantine

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 or GitHub token. Falls back to MERGIFY_TOKEN and then GITHUB_TOKEN env vars

-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
--debug flag

Enable verbose debug logging. Mirrors the Python CLI's top-level --debug flag so the same invocations work against either binary; native commands accept it as a no-op today (no native code path consults it yet), shimmed ones re-inject it into the forwarded argv so the Python side can honor it

Was this page helpful?