Skip to content

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

Draft
samgutentag wants to merge 1 commit intomainfrom
sam-gutentag/flaky-tests-branch-filter-glob-patterns
Draft

docs(flaky-tests): document branch glob filtering and admin-only investigations setting#576
samgutentag wants to merge 1 commit 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

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

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

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