Skip to content

docs(flaky-tests): document branch glob filtering and admin-only investigations setting#576

Merged
trunk-staging-io[bot] merged 2 commits intomainfrom
sam-gutentag/flaky-tests-branch-filter-glob-patterns
May 6, 2026
Merged

docs(flaky-tests): document branch glob filtering and admin-only investigations setting#576
trunk-staging-io[bot] merged 2 commits intomainfrom
sam-gutentag/flaky-tests-branch-filter-glob-patterns

Conversation

@samgutentag
Copy link
Copy Markdown
Member

Summary

  • Documents glob pattern support (*, ?) for the branch filter in the Flaky Tests test run history tab
  • Notes that the "Investigate Flaky Tests" setting is now restricted to org admins

Source

Test plan

  • Preview in GitBook

Generated by Claude Code

…nvestigations setting

- Add glob pattern reference table to the Test History section of dashboard.md
  (trunk2 #3716: branch filter now matches via * and ? wildcards, not substring)
- Note that the Investigate Flaky Tests setting requires org-admin rights
  (trunk2 #3728: setting is now disabled for non-admins with tooltip)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@trunk-staging-io
Copy link
Copy Markdown

trunk-staging-io Bot commented Apr 24, 2026

😎 Merged successfully - details.

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Apr 24, 2026

Claude finished @samgutentag's task in 1m 13s —— View job


PR Review

  • Read repo structure for guidelines
  • Review changed files
  • Analyze diff for typos, grammar, and formatting
  • Post review feedback

Overall this is clean, well-scoped documentation. No blocking issues. A few minor suggestions below:

flaky-tests/autofix-flaky-tests.md

The {% hint style="info" %} block placement is correct and the wording is clear. No issues.

flaky-tests/dashboard.md

  1. Table separator style (dashboard.md, line 96): The separator |---|---| is valid Markdown but inconsistent with how GitBook typically renders. Consider | --- | --- | for readability, though this won't affect rendering.

  2. Inconsistent "e.g." usage in table (dashboard.md, lines 97–100): The first three data rows include an e.g. example, but the last row (trunk-merge/*) does not. Adding a short example like e.g. trunk-merge/feature-branch would make the table consistent. Fix this →

  3. UI element capitalization (dashboard.md, line 93): "test run history tab" could be capitalized as "Test Run History tab" if it reflects an exact UI element name. Verify against the actual UI.

None of these are blocking — the content is accurate, the examples are clear, and the new section fits naturally into the document structure.

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.

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 5, 2026

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


PR Review

  • Read repo structure for guidelines
  • Review changed files
  • Analyze diff for typos, grammar, and formatting
  • Post review feedback

Overall this is clean, well-scoped documentation. No blocking issues. A few minor suggestions below (same as the previous review — these remain unaddressed after the latest push):

flaky-tests/autofix-flaky-tests.md

The {% hint style="info" %} block is well-placed and the wording is clear. No issues.

flaky-tests/dashboard.md

  1. Table separator style (dashboard.md, line 96): |---|---| is valid Markdown but inconsistent with typical GitBook style. Consider | --- | --- | for readability, though this won't affect rendering.

  2. Inconsistent "e.g." usage (dashboard.md, line 100): The first three data rows include an e.g. example, but the trunk-merge/* row does not. Adding a short example like e.g. trunk-merge/feature-branch would make the table consistent. Fix this →

  3. UI element capitalization (dashboard.md, line 93): "test run history tab" could be capitalized as "Test Run History tab" if it reflects an exact UI element name. Verify against the actual UI.

None of these are blocking — the content is accurate, the glob pattern examples are correct, and the new section fits naturally into the document structure.

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. Review approved. Ready to merge.

@samgutentag samgutentag marked this pull request as ready for review May 6, 2026 18:08
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 6, 2026

Claude finished @samgutentag's task in 1m 15s —— View job


PR Review

  • Read repo guidelines (CLAUDE.md)
  • Review changed files
  • Analyze diff for typos, grammar, and formatting
  • Post review feedback

Re-reviewed after the latest push. The content is accurate and the doc structure is sound — no blocking issues. The same minor, non-blocking notes from the previous two reviews still apply (the author has indicated the PR is approved and ready to merge):

flaky-tests/autofix-flaky-tests.md

The {% hint style="info" %} block placement (after the prerequisites list, before the figure) reads naturally and the wording is clear. No issues.

flaky-tests/dashboard.md

  1. Table style consistency (line 17, line 33 vs. line 95–100): The rest of dashboard.md uses HTML <table> markup, while the new section uses Markdown pipe-table syntax. Both render fine in GitBook, but mixing styles within one file is slightly inconsistent. Not blocking — flagging for awareness.

  2. Inconsistent "e.g." examples (line 100): The first three table rows give an e.g. example; the trunk-merge/* row does not. A small example like e.g. trunk-merge/feature-branch would make the column read consistently. Fix this →

  3. UI element casing (line 93): "test run history tab" — if the actual UI label is "Test Run History," title-casing it (or wrapping the label in **bold**) would more clearly signal it's a UI element. Verify against the live UI.

  4. Glob example accuracy (line 99): feature-?? matches feature-v2 correctly (two ? = two chars, "v2" = two chars). Confirmed.

None of these are blocking — the glob pattern table is accurate, the hint block is well-placed, and the new content fits naturally into both pages. ✅
| Branch

@trunk-staging-io trunk-staging-io Bot merged commit d1a5690 into main May 6, 2026
8 checks passed
@trunk-staging-io trunk-staging-io Bot deleted the sam-gutentag/flaky-tests-branch-filter-glob-patterns branch May 6, 2026 18:10
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 added a commit that referenced this pull request May 7, 2026
Update the dashboard page to describe the new tabbed layout (Summary,
Test History, Monitors, Events) and add comprehensive documentation for
the Test History tab including the daily runs chart, filter bar, runs
table, and run detail panel.

Re-applied against current main and integrated with the branch glob
filter content from #576. Addresses prior PR review comments: row border
colors now include gray for skipped, and the quarantining wording is
scoped to the Events tab.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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