Skip to content

docs(flaky-tests): document quarantine status icons on repositories overview #553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
samgutentag wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(flaky-tests): document quarantine status icons on repositories overview #553

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions flaky-tests/dashboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,30 @@ description: >-

Trunk Flaky Tests detects flaky tests by analyzing test results. The health of your tests is displayed in the Flaky Tests dashboard.

### Repositories overview

When you navigate to `/<your-org>/flaky-tests`, you land on a repositories overview showing all monitored repositories at a glance.

Each repository row displays:

| Column | Description |
|--------|-------------|
| **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 |
Copy link
Copy Markdown
Contributor

@claude claude bot Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: "hover tooltips" is slightly redundant — tooltips by definition appear on hover. Consider simplifying:

Suggested change
| **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 |


A quarantine status icon appears next to each repository name when quarantining is configured:

| Icon | Meaning |
|------|---------|
| Shield | Quarantining is enabled for this repository; auto-quarantine is off |
| Shield with checkmark | Auto-quarantine is enabled — flaky tests are quarantined automatically |
Comment on lines +28 to +29
Copy link
Copy Markdown
Contributor

@claude claude bot Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The two rows use different separators — the first uses a semicolon (;) and the second an em dash (—). Using a consistent style would be cleaner:

Suggested change
| 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 |


Active repositories (with test data in the last 30 days) appear at the top of the list. Repositories with no recent data are collapsed under an **Inactive Repositories** section that you can expand to view.

Selecting a repository opens its detailed dashboard. If your organization has no repositories connected yet, the page redirects to onboarding. See [Quarantining](quarantining.md) to learn how to configure quarantine settings.

### Key repository metrics

<figure><picture><source srcset="../.gitbook/assets/key-metrics-dark.png" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/key-metrics-light.png" alt=""></picture><figcaption><p>Key repo metrics</p></figcaption></figure>
Expand Down
Loading