docs: document trunk-based workflow with executable examples - #5196
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The changes are documentation-focused with supporting executable examples, and the updates align with existing docs/test patterns without introducing product behavior changes.
Review details
- Files reviewed: 13/13 changed files
- Comments generated: 0 new
- Review effort level: Lite
arturcic
force-pushed
the
codex/3915-trunk-based-docs
branch
from
September 9, 2026 13:39
a4abf52 to
6e336ed
Compare
|
Contributor
|
Thank you @arturcic for your contribution! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Description
Add a practical guide for the experimental
TrunkBased/preview1preset, including minimal configuration, branch defaults, deployment modes, and worked examples. The examples use the unmodifiedTrunkBasedConfigurationBuilderand generate four Mermaid diagrams covering direct main commits, release tags, feature/hotfix merges, and commit-message increments.Link the guide from workflow selection and branching-strategy and configuration references. Restore the
#configuration-toolanchor with the history-verified explanation that the init wizard was removed in v6, and direct readers to current YAML configuration guidance. No production version-calculation behavior changes; rebuilding the wizard remains separate in #3900.Related Issue
Resolves #3915
Motivation and Context
The preset already exists, but has no dedicated guide or verified examples. Its defaults differ from the customized GitFlow Mainline examples, so the new examples assert the actual preset outputs.
How Has This Been Tested?
BuildDocscompleted for the 7.0, 6.8, and 5.12 editions, including rendered-link validation. Ran in a temporary clone containing identical changes because build-root discovery does not support linked worktrees.git diff --checkpassed; a second snippet regeneration made no changes.Checklist