Skip to content

docs(webhooks): move Flaky Tests webhook content off the Merge Queue page#285

Open
samgutentag wants to merge 1 commit into
mainfrom
sam-gutentag/mq-webhooks-ft-cleanup
Open

docs(webhooks): move Flaky Tests webhook content off the Merge Queue page#285
samgutentag wants to merge 1 commit into
mainfrom
sam-gutentag/mq-webhooks-ft-cleanup

Conversation

@samgutentag

Copy link
Copy Markdown
Contributor

What

The Merge Queue webhooks page carried three test_case.* sections — status_changed v1/v2, quarantining, and AI investigation — that are Flaky Tests events, not Merge Queue. Phil flagged it in Slack. This moves them to where they belong.

Changes

merge-queue/webhooks.mdx

  • Replaced the three FT sections with a one-line pointer to the Flaky Tests webhooks reference.
  • The page now documents only pull_request.* and pull_request_batch.* events.

flaky-tests/webhooks/index.mdx — absorbed the substance, which filled real gaps:

  • v1 → v2 deprecation note + "v2 omits failure_rate_last_7d; enrich via get-test-details" guidance under the v2 schema.
  • test_case.quarantining_setting_changedwas undocumented on the FT page; added with its manual-override-only behavior.
  • "Use v2.test_case.status_changed for became-flaky reactions" steer on the investigation event.
  • Softened "Trunk publishes three event types" → "the following" (the count was already wrong once you include the deprecated v1 and the quarantining event).

Notes

  • No new claims. Everything relocated to the FT page was already published on the MQ page — this is a move, not new authoring. The quarantining_setting_changed event points to the Svix catalog for its full schema rather than inventing a field table.
  • trunk fmt/check not run locally (repo isn't trunk init'd here); relying on the Mintlify CI check.

…page

The Merge Queue webhooks page carried three test_case.* sections (status_changed
v1/v2, quarantining, AI investigation) that belong to Flaky Tests. Phil flagged it.

- merge-queue/webhooks.mdx: replace the three FT sections with a one-line pointer
  to the Flaky Tests webhooks reference. MQ page now only covers pull_request.* and
  pull_request_batch.* events.
- flaky-tests/webhooks/index.mdx: absorb the substance, filling real gaps —
  v1->v2 deprecation + get-test-details enrichment note, the previously-undocumented
  test_case.quarantining_setting_changed event, and the "use v2 for became-flaky
  reactions" steer. Softened the brittle "three event types" count.

No new claims: all relocated content was already published on the MQ page.
@mintlify

mintlify Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
trunk 🟢 Ready View Preview Jun 26, 2026, 4:58 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant