Skip to content

docs(flaky-tests): clarify default stable branch recognition (main, master, develop) #552

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): clarify default stable branch recognition (main, master, develop) #552

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
6 changes: 5 additions & 1 deletion flaky-tests/get-started/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Trunk Flaky Tests detects flaky tests by analyzing test results from your CI run

* Account at [app.trunk.io](https://app.trunk.io)
* Ability to modify repository CI configuration and add secrets
* Tests running in CI on both PRs and stable branches (e.g., main)
* Tests running in CI on both PRs and stable branches (e.g., main, master, or develop)

#### Step 1: Ensure JUnit XML output

Expand All @@ -35,6 +35,10 @@ Add test result uploads to all CI jobs that run tests.

Uploads from both PRs and stable branches are required for Trunk Flaky Tests to accurately detect flaky tests.

{% hint style="info" %}
Trunk automatically recognizes `main`, `master`, and `develop` as stable branches. If your primary branch uses a different name, configure uploads from that branch the same way and Trunk will classify it correctly based on how your monitors are scoped.
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 clarity issue: "Trunk will classify it correctly based on how your monitors are scoped" references monitor scoping, but monitors aren't introduced until Step 4 — a reader encountering this in Step 2 may not know what "monitors are scoped" means yet.

Consider simplifying the second sentence to remove the forward-reference:

Suggested change
Trunk automatically recognizes `main`, `master`, and `develop` as stable branches. If your primary branch uses a different name, configure uploads from that branch the same way and Trunk will classify it correctly based on how your monitors are scoped.
Trunk automatically recognizes `main`, `master`, and `develop` as stable branches. If your primary branch uses a different name, configure uploads from that branch the same way and Trunk will classify it correctly.

{% endhint %}

#### Step 3: Verify integration

1. Push your changes and trigger a CI run
Expand Down
Loading