Skip to content

Comments

Add local tool installation and dnx execution documentation#4824

Merged
arturcic merged 1 commit intomainfrom
copilot/update-docs-dnx-usage
Feb 16, 2026
Merged

Add local tool installation and dnx execution documentation#4824
arturcic merged 1 commit intomainfrom
copilot/update-docs-dnx-usage

Conversation

Copy link
Contributor

Copilot AI commented Feb 16, 2026

Documentation only covered global tool installation. Added local tool installation via manifest and all execution methods including dnx variants.

Changes

  • Local tool installation: Documented manifest-based workflow with dotnet new tool-manifest and dotnet tool install GitVersion.Tool
  • Execution methods: Added all four invocation patterns with correct syntax:
    • dotnet gitversion - standard (uses command name)
    • dotnet tool exec GitVersion.Tool - explicit (uses package name)
    • dotnet dnx GitVersion.Tool - shorthand alias
    • dnx GitVersion.Tool - shortest form
  • Package name casing: Use GitVersion.Tool (proper casing matching NuGet)
  • Version examples: Updated from 5.* to 6.*

Key distinction: direct invocation uses command name gitversion, while tool exec/dnx variants require package name GitVersion.Tool.

# Install as local tool
dotnet tool install GitVersion.Tool --version 6.*

# Standard invocation
dotnet gitversion

# Explicit manifest execution
dnx GitVersion.Tool
Original prompt

This section details on the original issue you should resolve

<issue_title>Update docs to include dnx usage</issue_title>
<issue_description></issue_description>

<agent_instructions>Please update the docs to include the option of installing the dotnet global tool GitVersion.Tool using dnx in the docs/</agent_instructions>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI changed the title [WIP] Update documentation to include dnx usage for GitVersion.Tool docs: Add .NET local tool installation method Feb 16, 2026
Copilot AI requested a review from arturcic February 16, 2026 12:06
Copilot AI changed the title docs: Add .NET local tool installation method docs: Add local tool installation and dnx execution methods Feb 16, 2026
Copilot AI changed the title docs: Add local tool installation and dnx execution methods Add local tool installation and dnx execution documentation Feb 16, 2026
@arturcic arturcic marked this pull request as ready for review February 16, 2026 12:28
Copilot AI review requested due to automatic review settings February 16, 2026 12:28
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request aims to document local tool installation for GitVersion and alternative execution methods. However, it introduces critical errors by documenting invalid dnx commands that are not part of the modern .NET CLI. The PR correctly documents local tool installation via manifest and updates version examples from 5.* to 6.*, but the execution method documentation contains significant inaccuracies.

Changes:

  • Added .NET Local Tool section documenting manifest-based installation workflow
  • Updated version examples from 5.* to 6.*
  • Documented dotnet tool exec execution method (correct)
  • Incorrectly documented dnx and dotnet dnx commands as valid execution methods (critical error)
  • Added reference links for local tool documentation

Adds detailed guidance for installing GitVersion as a local tool, including `dnx` command execution examples, and updates global tool examples to version 6.x.
@arturcic arturcic force-pushed the copilot/update-docs-dnx-usage branch from 95e8f9c to 68ca742 Compare February 16, 2026 12:37
@arturcic arturcic merged commit 4520b97 into main Feb 16, 2026
3 of 5 checks passed
@arturcic arturcic deleted the copilot/update-docs-dnx-usage branch February 16, 2026 12:38
@mergify
Copy link
Contributor

mergify bot commented Feb 16, 2026

Thank you @Copilot for your contribution!

@sonarqubecloud
Copy link

gittools-bot pushed a commit that referenced this pull request Feb 16, 2026
Merge pull request #4824 from GitTools/copilot/update-docs-dnx-usage

Add local tool installation and dnx execution documentation
This was referenced Feb 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update docs to include dnx usage

2 participants