Skip to content

Commit 05d11f5

Browse files
Update description of TrackReleaseBranches version strategy
1 parent c3bf45b commit 05d11f5

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/input/docs/learn/how-it-works.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,9 @@ Currently we have the following strategies:
4949
* `Fallback` - Always returns 0.0.0 and will be used for
5050
calculating the next version which is dependent on the increment strategy of
5151
the effected branch (e.g. on main the next version is 0.0.1 or on develop it is 0.1.0)
52-
* `TrackReleaseBranches` - TODO: Document this
52+
* `TrackReleaseBranches` - Considers the base version extracted from release branches when
53+
calculating the next version for branches configured with `track-release-branches: true`
54+
(part of default configuration for `develop` branch in `GitFlow` workflow)
5355
* `Mainline` - Increments the version on every commit for branches configured with `mode: Mainline`
5456

5557
Each strategy needs to return an instance of `BaseVersion` which has the

0 commit comments

Comments
 (0)