docs(test-insights): Document mergify tests show and tests APIs#11655
Merged
Conversation
Contributor
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 🤖 Continuous IntegrationWonderful, this rule succeeded.
🟢 👀 Review RequirementsWonderful, this rule succeeded.
🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 🔎 ReviewsWonderful, this rule succeeded.
🟢 📕 PR descriptionWonderful, this rule succeeded.
|
There was a problem hiding this comment.
Pull request overview
Adds first-class documentation for the mergify tests show CLI workflow under Test Insights, making the command discoverable from both the Test Insights hub and the general CLI docs.
Changes:
- Add a new
/test-insights/cliguide documentingmergify tests showusage, filters, JSON output, and exit codes, plus agent-oriented recipes. - Add navigation and cross-links to surface the new guide from the Test Insights section and the main CLI page.
- Update the Test Insights overview page to mention terminal/agent lookup via the new command.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/content/navItems.tsx | Adds “CLI Lookup” entry under the Test Insights navigation group. |
| src/content/docs/test-insights/cli.mdx | New dedicated guide for mergify tests show, including examples, exit codes, and agent recipes. |
| src/content/docs/test-insights.mdx | Adds a link from the Test Insights overview to the new CLI Lookup guide. |
| src/content/docs/cli.mdx | Adds mergify tests show to the CLI command table with a doc link. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
8136796 to
2fb0258
Compare
Contributor
Author
Revision history
|
2fb0258 to
44b74e7
Compare
44b74e7 to
f7d7737
Compare
Mergify CLI #1382 shipped `mergify tests show` so developers and AI coding agents (Claude Code, Cursor, …) can decide whether a failing test is a real regression or known flakiness without parsing dashboards. Until now the command was undiscoverable from the docs site — agents that ran it from a skill could not link users to a reference, and developers had no entry point besides `--help`. Adds a dedicated `/test-insights/cli` guide covering single- and multi- test lookups, glob patterns, pipeline/job filters, JSON output, and the 0/1/6 exit-code contract (clap reserves `2`). A second half walks through agent recipes for routing failures to retry vs. fix vs. ignore based on exit code alone, plus a Claude Code skill snippet and Cursor project rule. The two backing endpoints (`GET …/search/tests`, `GET …/tests/{test_id}`) are auto-generated into the API reference from the engine's OpenAPI schema, so the guide links to `/api/test-insights` rather than duplicating the schema. `/tests/{test_id}/stats/{stat}` stays out of scope: it is `include_in_schema=False` server-side and not used by the CLI. The guide intentionally documents the shipped surface, which diverged from the MRGFY-7167 spec during MRGFY-7166 implementation: the command is `mergify tests show` (not `mergify ci tests show`), there is no `--quiet` flag, exit codes are `0/1/6` (not `0/1/2`), and the search endpoint is `GET` with repeated query params (not `POST` with a JSON body). Documenting reality beats documenting the plan. Fixes: MRGFY-7167 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Change-Id: I54b1908accda0ad2d2bf538af10e5960d76ad9b2
f7d7737 to
fba8a54
Compare
kozlek
approved these changes
May 22, 2026
JulianMaurin
approved these changes
May 22, 2026
Contributor
Merge Queue Status
This pull request spent 2 minutes 24 seconds in the queue, including 2 minutes 4 seconds running CI. Required conditions to merge
|
51 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Mergify CLI #1382 shipped
mergify tests showso developers and AIcoding agents (Claude Code, Cursor, …) can decide whether a failing test
is a real regression or known flakiness without parsing dashboards.
Until now the command was undiscoverable from the docs site — agents
that ran it from a skill could not link users to a reference, and
developers had no entry point besides
--help.Adds a dedicated
/test-insights/cliguide covering single- and multi-test lookups, glob patterns, pipeline/job filters, JSON output, and the
0/1/6 exit-code contract (clap reserves
2). A second half walksthrough agent recipes for routing failures to retry vs. fix vs. ignore
based on exit code alone, plus a Claude Code skill snippet and Cursor
project rule.
The two backing endpoints (
GET …/search/tests,GET …/tests/{test_id}) are auto-generated into the API reference fromthe engine's OpenAPI schema, so the guide links to
/api/test-insightsrather than duplicating the schema.
/tests/{test_id}/stats/{stat}stays out of scope: it is
include_in_schema=Falseserver-side and notused by the CLI.
The guide intentionally documents the shipped surface, which diverged
from the MRGFY-7167 spec during MRGFY-7166 implementation: the command
is
mergify tests show(notmergify ci tests show), there is no--quietflag, exit codes are0/1/6(not0/1/2), and the searchendpoint is
GETwith repeated query params (notPOSTwith a JSONbody). Documenting reality beats documenting the plan.
Fixes: MRGFY-7167
Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com