Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Docs]: Confusing/missing documentation around strategies #4219

@selfdocumentingcode

Description

@selfdocumentingcode

Prerequisites

  • I have written a descriptive issue title
  • I have searched issues to ensure it has not already been reported

GitVersion package

GitVersion.Tool

GitVersion version

6.x

Operating system

Linux

What are you seeing?

https://gitversion.net/docs/learn/how-it-works lists:

  • HighestReachableTag
  • NextVersionInConfig
  • MergedBranchWithVersion
  • HighestTagBaseVersionStrategy
  • VersionInBranchBaseVersionStrategy
  • ConfigNextVersionBaseVersionStrategy
  • MergeMessageBaseVersionStrategy
  • FallbackBaseVersionStrategy

Issues:

  • There's no HighestReachableTag strategy
  • There's no HighestTagBaseVersionStrategy strategy
  • NextVersionInConfig should be called ConfigureNextVersionVersionStrategy
  • ConfigNextVersionBaseVersionStrategy should be called ConfigureNextVersionVersionStrategy
  • TrackReleaseBranchesVersionStrategy is not documented
  • MainlineVersionStrategy is not documented
  • There's nothing called "BaseVersionStrategy" in the code (sans a few tests classes) or other places in the documentation.

https://gitversion.net/docs/reference/configuration lists:

  • TrunkBased

Issues:

  • Should list Mainline instead

What is expected?

Versioning strategies to be correctly documented.

Steps to Reproduce

Read documentation

RepositoryFixture Test

No response

Output log or link to your CI build (if appropriate).

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions