Skip to content

docs(flaky-tests): document repositories overview landing page#549

Closed
samgutentag wants to merge 2 commits intomainfrom
sam-gutentag/flaky-tests-repos-overview
Closed

docs(flaky-tests): document repositories overview landing page#549
samgutentag wants to merge 2 commits intomainfrom
sam-gutentag/flaky-tests-repos-overview

Conversation

@samgutentag
Copy link
Copy Markdown
Member

Summary

  • Adds a new "Repositories overview" section to flaky-tests/dashboard.md
  • Documents the multi-repo landing page introduced in trunk-io/trunk2#3527
  • Covers the per-repo TESTS/FLAKY/BROKEN counts, RUNS/DAY sparkline, inactive repos section, and quarantine lock icon

Source

Test plan

  • Preview in GitBook

Documents the new multi-repo overview dashboard added in trunk-io/trunk2#3527.
The landing page at /<org>/flaky-tests now shows all monitored repositories
with TESTS, FLAKY, BROKEN counts and a RUNS/DAY sparkline per repo.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 5, 2026

Claude finished @samgutentag's task in 58s —— View job


Review complete

  • Gather context (read CLAUDE.md and changed files)
  • Review changes for typos, grammar, and formatting
  • Post review feedback

The new "Repositories overview" section is well-written, clear, and correctly placed before "Key repository metrics" (matching the user flow). Two minor notes left as inline comments:

  1. "Bar chart" vs "sparkline" (line 22) — The PR description calls it a "sparkline". If the UI renders it as a small inline chart without axes, "sparkline" is the more precise term. Suggestion included.
  2. Table format inconsistency (line 17) — The rest of the file uses HTML <table> syntax with explicit column widths. The new section uses GFM markdown table syntax. Both work in GitBook, but aligning with the file's existing style would keep things consistent. Style note only, not a blocker.

No typos, grammar issues, or structural problems found. Content is accurate and the section flows naturally into the rest of the page.

Comment thread flaky-tests/dashboard.md
| **Tests** | Total tracked test cases in the repository |
| **Flaky** | Number of currently flaky test cases |
| **Broken** | Number of currently broken test cases |
| **Runs / Day** | Bar chart of test run volume over the last 10 days, with per-day hover tooltips |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The PR description refers to this as a "sparkline" — worth checking which term matches the actual UI. If it's a small inline chart (no axes/labels), "sparkline" is the more precise term.

Suggested change
| **Runs / Day** | Bar chart of test run volume over the last 10 days, with per-day hover tooltips |
| **Runs / Day** | Sparkline of test run volume over the last 10 days, with per-day hover tooltips |

Comment thread flaky-tests/dashboard.md

Each repository row displays:

| Column | Description |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The rest of this file uses HTML table syntax (e.g., <table><thead>...) with explicit column widths. This new section uses GFM markdown table syntax. Both render fine in GitBook, but for consistency with the rest of the file you may want to use the HTML format here too. This is a style note, not a blocker.

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Auto-approved: Claude code review passed.

@samgutentag
Copy link
Copy Markdown
Member Author

Triage status (2026-05-05): up to date with main. Needs review before merge.

trunk-staging-io Bot pushed a commit that referenced this pull request May 6, 2026
…verview (#553)

## Summary

- Adds a **Repositories overview** section to `flaky-tests/dashboard.md`
- Documents the quarantine status icons introduced in
trunk-io/trunk2#3538:
  - Shield icon: quarantining is enabled, auto-quarantine is off
  - Shield with checkmark icon: auto-quarantine is enabled
- Includes full column reference for the repos overview table (Tests,
Flaky, Broken, Runs/Day)
- Links to the Quarantining page for configuration details

## Source

- trunk2 PR: trunk-io/trunk2#3538

## 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

- [ ] Preview in GitBook

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
@samgutentag
Copy link
Copy Markdown
Member Author

Verification status (2026-05-06): live

Verified: customers can use this. Ready to publish.

  • Eng PR: trunk-io/trunk2#3527 (merged 2026-04-14)
  • Flag: none (no LaunchDarkly gate found in PR body or diff)
  • Signals:
    • Merge commit on main (status: behind, merge intact)
    • No feature flag patterns in PR diff
    • PR replaces the existing /[orgSlug]/flaky-tests redirect with a new landing page; not behind a flag

Branch has a merge conflict. Resolve before merge.

@samgutentag
Copy link
Copy Markdown
Member Author

Closing as superseded. PR #553 shipped a strict superset of this content to main on 2026-04-something, with additional detail this PR was missing:

  • Tests column now qualified as "60-day window"
  • Flaky and Broken columns now mention their 10-day trend sparklines (separate from the Runs/Day bar chart)
  • Quarantine status replaced from a single-sentence note about a lock icon to a full table distinguishing Shield (quarantining enabled, auto-quarantine off) from Shield with checkmark (auto-quarantine on)
  • Cross-link to the Quarantining page from the selecting-a-repository paragraph

The only marginal contribution this PR retained was "per-day hover tooltips" vs main's "per-day tooltips," and tooltips imply hover by default. Not worth a follow-up.

Same close-and-skip pattern as #499 and #547. See the verify-docs-pr comment above for the full assessment.

@samgutentag samgutentag closed this May 7, 2026
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.

2 participants