docs(flaky-tests): document quarantine status icons on repositories overview#553
docs(flaky-tests): document quarantine status icons on repositories overview#553samgutentag wants to merge 1 commit intomainfrom
Conversation
…verview The repositories overview now shows Shield (quarantining on, auto-quarantine off) and ShieldCheck (auto-quarantine enabled) icons next to repo names. Adds the full repositories overview section with column reference and icon legend. Source: trunk-io/trunk2#3538 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 14s —— View job Review Complete
The new Repositories overview section is well-structured, clear, and fits naturally before the existing "Key repository metrics" section. Content is accurate and easy to follow. Two minor suggestions posted as inline comments:
Neither is blocking. The section could benefit from a screenshot (other sections include figures), but that's a nice-to-have given this documents a new feature. |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
| | **Tests** | Total tracked test cases in the repository (60-day window) | | ||
| | **Flaky** | Number of currently flaky test cases, with a 10-day trend sparkline | | ||
| | **Broken** | Number of currently broken test cases, with a 10-day trend sparkline | | ||
| | **Runs / Day** | Bar chart of test run volume over the last 10 days, with per-day hover tooltips | |
There was a problem hiding this comment.
Minor: "hover tooltips" is slightly redundant — tooltips by definition appear on hover. Consider simplifying:
| | **Runs / Day** | Bar chart of test run volume over the last 10 days, with per-day hover tooltips | | |
| | **Runs / Day** | Bar chart of test run volume over the last 10 days, with per-day tooltips | |
| | Shield | Quarantining is enabled for this repository; auto-quarantine is off | | ||
| | Shield with checkmark | Auto-quarantine is enabled — flaky tests are quarantined automatically | |
There was a problem hiding this comment.
The two rows use different separators — the first uses a semicolon (;) and the second an em dash (—). Using a consistent style would be cleaner:
| | Shield | Quarantining is enabled for this repository; auto-quarantine is off | | |
| | Shield with checkmark | Auto-quarantine is enabled — flaky tests are quarantined automatically | | |
| | Shield | Quarantining is enabled for this repository — auto-quarantine is off | | |
| | Shield with checkmark | Auto-quarantine is enabled — flaky tests are quarantined automatically | |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
2 participants
Summary
flaky-tests/dashboard.mdSource
Notes
This PR overlaps with #549 which documents the initial repos overview feature (trunk-io/trunk2#3527). One of the two should be updated to include the other's content before merging, or they can be merged in sequence with a follow-up cleanup.
Test plan