Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] GitVersion.Tool installation not documented #2584

Closed
mpoettgen opened this issue Feb 6, 2021 · 4 comments · Fixed by #2586
Closed

[Feature] GitVersion.Tool installation not documented #2584

mpoettgen opened this issue Feb 6, 2021 · 4 comments · Fixed by #2586
Milestone

Comments

@mpoettgen
Copy link
Contributor

Detailed Description

The documentation at https://gitversion.net/docs/usage/command-line doesn't mention the option to install GitVersion via:

dotnet tool install -g GitVersion.Tool

Context

Even though GitVersion.Tool is mentioned in the README.md it is not listed as an install option on the page referenced above. This is confusing as it seams to be the easiest method to install GitVersion as it doesn't require Chocolatey, Homebrew or any other package manager for installation. At least for .NET (5+) and .NET Core projects the dotnet CLI is already present.

Possible Implementation

Mention how to install GitVersion as a global tool.

@arturcic
Copy link
Member

arturcic commented Feb 6, 2021

@mpoettgen would you mind to send us a PR to fix this?

@mpoettgen
Copy link
Contributor Author

Can do.

@mpoettgen
Copy link
Contributor Author

@arturcic like that? Let me know, if you want more or less.

@arturcic arturcic added this to the 5.6.5 milestone Feb 6, 2021
@arturcic arturcic linked a pull request Feb 6, 2021 that will close this issue
5 tasks
@arturcic arturcic removed a link to a pull request Feb 6, 2021
5 tasks
@github-actions
Copy link

github-actions bot commented Feb 7, 2021

🎉 This issue has been resolved in version 5.6.5 🎉
The release is available on:

Your GitReleaseManager bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants