Skip to content

Commit

Permalink
Update description of Mainline strategy in how-it-works
Browse files Browse the repository at this point in the history
  • Loading branch information
selfdocumentingcode committed Sep 23, 2024
1 parent 6008b82 commit 840ece2
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/input/docs/learn/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ simply to show what happens if the check is true.

Currently we have the following strategies:

* `TaggedCommit` - Extracts version information from all tags on the branch which are valid, and not newer than the current commit.
* `TaggedCommit` - Extracts version information from all tags on the branch which are valid,
and not newer than the current commit.
* `VersionInBranchName` - Extracts version information from the
branch name (e.g., `release/3.0.0` will find `3.0.0`)
* `ConfiguredNextVersion` - Returns the version from the
Expand All @@ -49,7 +50,7 @@ Currently we have the following strategies:
calculating the next version which is dependent on the increment strategy of
the effected branch (e.g. on main the next version is 0.0.1 or on develop it is 0.1.0)
* `TrackReleaseBranches` - TODO: Document this
* `Mainline` - TODO: Document this
* `Mainline` - Increments the version on every commit for branches configured with `mode: Mainline`

Each strategy needs to return an instance of `BaseVersion` which has the
following properties:
Expand Down

0 comments on commit 840ece2

Please sign in to comment.