Skip to content

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

Draft
samgutentag wants to merge 1 commit intomainfrom
sam-gutentag/default-stable-branches
Draft

docs(flaky-tests): clarify default stable branch recognition (main, master, develop)#552
samgutentag wants to merge 1 commit intomainfrom
sam-gutentag/default-stable-branches

Conversation

@samgutentag
Copy link
Copy Markdown
Member

Summary

Trunk now automatically recognizes main, master, and develop as stable branches for upload classification (trunk-io/trunk2#3555). This PR updates the Getting Started page to reflect that default:

  • Update prerequisites bullet to list all three default branch names
  • Add an info hint explaining the automatic recognition

Source

Test plan

  • Preview in GitBook

Trunk now automatically recognizes main, master, and develop as stable
branches for upload classification. Reflect this in the getting started
prerequisites and add a hint for repos using other branch names.

Source: trunk-io/trunk2#3555

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 16, 2026

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


PR Review

  • Read changed files
  • Check for typos, grammar, and formatting issues
  • Review documentation best practices
  • Post inline comments for specific issues
  • Provide final summary

The changes look good overall. The PR correctly updates the prerequisites to list all three default stable branch names and adds a helpful info hint.

One minor suggestion (non-blocking): The hint at line 39 says "Trunk will classify it correctly based on how your monitors are scoped" — but monitors aren't introduced until Step 4. A reader in Step 2 may not know what "monitors are scoped" means yet. I've left an inline suggestion to simplify that sentence.

Everything else is accurate, clear, and well-formatted. No blocking issues.

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

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.

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