Skip to content

Commit

Permalink
Remove unused TrackReleaseBranches strategy listing from how-it-works
Browse files Browse the repository at this point in the history
Mark TrackReleaseBranches as unused in configuration.md since technically it is an allowed value even though it's a noop.
  • Loading branch information
selfdocumentingcode committed Sep 23, 2024
1 parent 6008b82 commit a46ce7c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 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 @@ -48,8 +49,7 @@ Currently we have the following strategies:
* `Fallback` - Always returns 0.0.0 and will be used for
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
2 changes: 1 addition & 1 deletion docs/input/docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -955,7 +955,7 @@ Specifies which version strategy implementation (one ore more) will be used to d
- ConfiguredNextVersion
- MergeMessage
- TaggedCommit
- TrackReleaseBranches
- TrackReleaseBranches (currently unused)
- VersionInBranchName
- Mainline

Expand Down

0 comments on commit a46ce7c

Please sign in to comment.