Enable users to install unlisted version of tool if specify the exact match of the version of the tool #36021
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dotnet-issue-labeler
bot
added
Area-Tools
untriaged
JL03-Yue
force-pushed
the
fix-unlisted-tools
branch
from
63086b7 to
b0f6e36
Compare
JL03-Yue
changed the title
src/Tests/dotnet.Tests/CommandTests/ToolInstallGlobalOrToolPathCommandTests.cs
Outdated
Show resolved
Hide resolved
dsplaisted
approved these changes
Oct 16, 2023
src/Cli/dotnet/NugetPackageDownloader/NuGetPackageDownloader.cs
Outdated
Show resolved
Hide resolved
src/Tests/dotnet.Tests/CommandTests/ToolInstallGlobalOrToolPathCommandTests.cs
Show resolved
Hide resolved
…sted tests in CI; fix wording and version
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
JL03-Yue
added
the
breaking-change
ghost
added
the
|
Added When you commit this breaking change:
Tagging @dotnet/compat for awareness of the breaking change. |
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Customer Impact
In .NET 8 we made a breaking change that changes the current .NET tool installation mechanism from restore a local temporary project to downloading the .NET tool from NuGet. This change was introduced because this previous mechanism has number of side effects, often show up as flaky restore errors because MSBuild concepts like Directory.Build.props, or other heirarchical notions, pollute the restore.
The change, however, disable users from installing unlisted tools. Previously, users were able to install unlisted tools per fix in #28951. However, since the mechanism of tool installation are changed, the unlisted tools' downloading are disabled by default. For users, installing unlisted tools are a useful method because it provides clarity and simplicity for those who write tools independently or do not share the tools to the public.
The intended way to fix this is to provide a feature to allow users to install the unlisted version but only if the user specify the exact match, i.e.
[version]. (referred to NuGet package version reference). To add this feature, an unlisted parameter is passed to the NuGet API if a exact version is detected. Changes are validated by tests.Testing
Existing unit tests passed without changes. New tested are added to validate an unlisted tool can be installed with exact version match, and failed to be installed without the version match. The new testing scenarios pass with changes in the pull request.
Risk
Low. This change adds a feature that was missed from breaking change without adding complexity to the behavior.
Original description
Referred to some deprecated global tools get NuGetPackageNotFoundException when installing