docs: correct Flag as Flaky precedence — broken status overrides the manual flag - #300
Merged
Merged
Conversation
…manual flag The flag-as-flaky page claimed a flagged test is marked flaky regardless of what monitors report. In reality status resolution picks the most severe classification, so an active broken monitor keeps the test Broken while flagged. Document the precedence, the disabled flag button while a test is broken, and steer users toward muting or reconfiguring the responsible monitor when they believe a classification is incorrect.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
TylerJang27
approved these changes
Jul 24, 2026
Co-authored-by: Tyler Jang <tyler@trunk.io>
Contributor
|
Docs PR opened: #301 Added a changelog entry noting the Flag as Flaky button is disabled while a test is broken. |
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
2 participants
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.
Summary
The Flag as Flaky docs claimed a flagged test is "marked as flaky, regardless of what automated monitors report." In reality, status reconciliation picks the most severe active classification — Broken > Flaky > Healthy — so an active broken monitor keeps the test Broken even while flagged.
flaky-tests/detection/flag-as-flaky.mdx— reword the intro and "Once flagged" section, add an Info callout on broken precedence (including that the Flag as Flaky button is disabled while a test is broken, while flag removal remains available), and extend the status scenario table with broken rows.flaky-tests/detection/index.mdx— add a "When to Mute vs. Other Options" row steering users who believe a Broken/Flaky classification is wrong toward muting the responsible monitor or updating its configuration.flaky-tests/management/managing-detected-flaky-tests.mdx— correct the "Flag flaky tests" step to note the broken-status exception and the mute/reconfigure remediation.Companion product change: trunk-io/trunk2#4830 (popup wording + disabled button while broken).
🤖 Generated with Claude Code