-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Document breaking change: ToolCommandName no longer set for non-tool packages #50274
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
54 changes: 54 additions & 0 deletions
54
docs/core/compatibility/sdk/10.0/toolcommandname-not-set.md
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| title: "Breaking change - ToolCommandName is not set for non tool packages" | ||
| description: "Learn about the breaking change in .NET 10 where ToolCommandName is only set for projects with PackAsTool set to true." | ||
| ms.date: 12/02/2025 | ||
| ai-usage: ai-assisted | ||
| --- | ||
|
|
||
| # `ToolCommandName` not set for non-tool packages | ||
|
|
||
| The `ToolCommandName` property is no longer set automatically for all projects during build or package operations. It's now only set when `PackAsTool` is set to `true`, indicating that the project is a .NET tool package. | ||
|
|
||
| ## Version introduced | ||
|
|
||
| .NET 10 | ||
|
|
||
| ## Previous behavior | ||
|
|
||
| Previously, the `ToolCommandName` property was always set during build or pack operations, regardless of whether the project was configured as a tool package. | ||
|
|
||
| ## New behavior | ||
|
|
||
| Starting in .NET 10, the `ToolCommandName` property is only set when `PackAsTool` is set to `true`, indicating that the project is a .NET tool. | ||
|
|
||
| ## Type of breaking change | ||
|
|
||
| This change can affect [source compatibility](../../categories.md#source-compatibility). | ||
|
|
||
| ## Reason for change | ||
|
|
||
| The `ToolCommandName` property doesn't make sense for non-tool projects. Setting it for all projects was unnecessary and could cause confusion about the project's purpose. | ||
|
|
||
| ## Recommended action | ||
|
|
||
| If your project relies on the `ToolCommandName` property being set, you have two options: | ||
|
|
||
| - Set the property explicitly in your project file: | ||
|
|
||
| ```xml | ||
| <PropertyGroup> | ||
| <ToolCommandName>your-command-name</ToolCommandName> | ||
| </PropertyGroup> | ||
| ``` | ||
|
|
||
| - Convert your project to a .NET tool by setting `PackAsTool` to `true`: | ||
|
|
||
| ```xml | ||
| <PropertyGroup> | ||
| <PackAsTool>true</PackAsTool> | ||
| </PropertyGroup> | ||
| ``` | ||
|
|
||
| ## Affected APIs | ||
|
|
||
| None. | ||
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.