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

fourpastmidnight commented 3 weeks ago

Prerequisites

[x] I have written a descriptive issue title
[x] 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

arturcic commented 3 weeks ago

I think this is a no issue for GitVersion.Tool, that's a dotnet tool thing, closing

fourpastmidnight commented 3 weeks ago

No, it's a documentation issue thing. Wish you wouldn't close an issue for errant docs 😒

Get Outlook for Androidhttps://aka.ms/AAb9ysg

From: Artur @.> Sent: Friday, October 4, 2024 12:33:47 PM To: GitTools/GitVersion @.> Cc: Craig E. Shea @.>; Author @.> Subject: Re: [GitTools/GitVersion] [ISSUE]: dotnet tool install docs should not use an explicit --version arg (Issue #4244)

I think this is a no issue for GitVersion.Tool, that's a dotnet tool thing, closing

— Reply to this email directly, view it on GitHubhttps://github.com/GitTools/GitVersion/issues/4244#issuecomment-2394072894, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ABUTP2II5YOPOE2FP3AB6QLZZ27OXAVCNFSM6AAAAABPMB7ZY2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGOJUGA3TEOBZGQ. You are receiving this because you authored the thread.Message ID: @.***>

asbjornu commented 3 weeks ago

I agree that we should update the installation instructions and either remove --version altogether or at least set it to version 6 and not 5 as it is now.

fourpastmidnight commented 3 weeks ago

I'd rather remove it altogether, but if deemed helpful, add a note as I demonstrated in the original issue. Thanks for reopening.

Get Outlook for Androidhttps://aka.ms/AAb9ysg

From: Asbjørn Ulsberg @.> Sent: Friday, October 4, 2024 7:18:54 PM To: GitTools/GitVersion @.> Cc: Craig E. Shea @.>; Author @.> Subject: Re: [GitTools/GitVersion] [ISSUE]: dotnet tool install docs should not use an explicit --version arg (Issue #4244)

I agree that we should update the installation instructionshttps://gitversion.net/docs/usage/cli/installation and either remove --version altogether or at least set it to version 6 and not 5 as it is now.

— Reply to this email directly, view it on GitHubhttps://github.com/GitTools/GitVersion/issues/4244#issuecomment-2394780632, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ABUTP2ML6FZ4TGLNEA3BFSLZZ4O55AVCNFSM6AAAAABPMB7ZY2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGOJUG44DANRTGI. You are receiving this because you authored the thread.Message ID: @.***>

GitTools / GitVersion