docs(flaky-tests): document automatic label application from monitors#651
docs(flaky-tests): document automatic label application from monitors#651samgutentag wants to merge 1 commit into
Conversation
…application Monitors can now apply labels to test cases as an alternative to classifying them as flaky or broken. Remove the "coming soon" placeholder in test-labels.md and replace with a concrete how-to for configuring label-applying monitors. Source: trunk-io/trunk2#3945 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Merging to
After your PR is submitted to the merge queue, this comment will be automatically updated with its status. If the PR fails, failure details will also be posted here |
|
Claude finished @samgutentag's task in 1m 22s —— View job Claude PR Review
SummaryThe PR replaces the "Coming soon" placeholder with clear, well-structured documentation for the new monitor action types. Content is accurate, mirrors the established phrasing pattern from No typos, no grammar errors, no broken anchors, no logic issues. The relative link target ( Inline feedback (all non-blocking)
Verdict✅ Approving from a docs-review standpoint. The one style consistency nit on the numbered list is worth picking up, but nothing here blocks merging. |
| 1. Go to **Flaky Tests** > select your repository > **Monitors** | ||
| 2. Click **Add** next to the monitor type you want to create | ||
| 3. In the creation form, select **Apply labels** as the action type | ||
| 4. Choose one or more labels to apply when the monitor activates | ||
| 5. Complete the rest of the monitor configuration and save |
There was a problem hiding this comment.
Style consistency — numbered list punctuation.
Other numbered lists in this directory (e.g., flaky-tests/management/managing-detected-flaky-tests.md and flaky-tests/detection/failure-count-monitor.md) end each step with a period. These steps don't, which makes the list look inconsistent with the rest of the docs.
| 1. Go to **Flaky Tests** > select your repository > **Monitors** | |
| 2. Click **Add** next to the monitor type you want to create | |
| 3. In the creation form, select **Apply labels** as the action type | |
| 4. Choose one or more labels to apply when the monitor activates | |
| 5. Complete the rest of the monitor configuration and save | |
| 1. Go to **Flaky Tests** > select your repository > **Monitors**. | |
| 2. Click **Add** next to the monitor type you want to create. | |
| 3. In the creation form, select **Apply labels** as the action type. | |
| 4. Choose one or more labels to apply when the monitor activates. | |
| 5. Complete the rest of the monitor configuration and save. |
|
|
||
| When creating a failure count or failure rate monitor, you choose the **action type**: | ||
|
|
||
| * **Classify test status** — the monitor marks tests as flaky or broken (the default behavior) |
There was a problem hiding this comment.
Minor: "(the default behavior)" — since the parallel bullet Apply labels also describes a behavior, "default behavior" reads slightly awkwardly. Consider just "(default)" for parallelism, e.g.:
| * **Classify test status** — the monitor marks tests as flaky or broken (the default behavior) | |
| * **Classify test status** — the monitor marks tests as flaky or broken (default) |
Non-blocking.
| 4. Choose one or more labels to apply when the monitor activates | ||
| 5. Complete the rest of the monitor configuration and save | ||
|
|
||
| Tests that the monitor flags will have the selected labels applied automatically. You can still apply or remove labels manually on top of what monitors set. |
There was a problem hiding this comment.
Optional wording polish: "what monitors set" is a bit terse and uses passive voice. Consider:
| Tests that the monitor flags will have the selected labels applied automatically. You can still apply or remove labels manually on top of what monitors set. | |
| When the monitor flags a test, the selected labels are applied automatically. You can still apply or remove labels manually on top of what monitors apply. |
Or keep the passive but use "apply" for parallelism with the rest of the section: "on top of what monitors apply" rather than "set". Non-blocking.
|
Verification status (2026-05-13): Eng merged but flag off in prod. Hold off.
Hold until the flag flips to 100% in prod (or a follow-up PR removes the gate). Re-run |
|
Claude finished @samgutentag's task in 58s —— View job Claude PR Review — re-review on
SummaryNo new changes since the prior review at 2026-05-13 11:00 UTC (file SHA
No typos, grammar errors, broken links, or structural issues. Anchor Verification statusPer @samgutentag's 2026-05-13 17:34 UTC comment, the eng PR (trunk-io/trunk2#3945) merged 2026-05-12 but Verdict✅ Approving from a docs-review standpoint. The numbered-list period nit is worth picking up before merge; the other two are optional polish. Hold the merge for the flag rollout, not for the review. |
|
superseded by #656 |
Summary
flaky-tests/management/test-labels.mdwith actual documentation on how monitors can automatically apply labels to test casesSource
Test plan
Generated by Claude Code