Skip to content

[ISSUE]: dotnet tool install docs should not use an explicit --version arg #4244

@fourpastmidnight

Description

@fourpastmidnight

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

Windows

What are you seeing?

I recently installed the dotnet tool for this project following the instructions on the documentation site: dotnet tool install --global GitVersion.Tool --version 5.*. : dotnet tool -g gitversion. Upon installation, running dotnet gitversion /version yields 5.12.0....

I initially forgot I had supplied a --version parameter when installing, hence the genesis of this issue.

What is expected?

I was expecting v6.x which is the currently released version. I expect that the documentation would be updated to not include a --version flag in the example. Perhaps a notice sidebar could be added to the docs to point people to the --version flag if they need to install an older version of the GitVersion.Tools package, such as:

Note

To install an older version of GitVersion.Tools, use the --version flag of dotnet tool install, e.g. dotnet tool install GitVersion.Tool --global --version 5.*

Steps to Reproduce

In the Visual Studio Terminal:

PS C:> dotnet tool -g install gitversion --version 5.*
PS C:> dotnet tool gitversion /version
5.12.0+Branch.support-5.x.Sha.3f75764963eb3d7956dcd5a40488c074dd9faf9e

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