Skip to content

Add support for building tool packages with runtime identifier set without building RID-specific packages #51281

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.

Sign up for GitHub

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 1 commit into from
Oct 16, 2025
Merged

Add support for building tool packages with runtime identifier set without building RID-specific packages #51281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.PackTool.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ NOTE: This file is imported from the following contexts, so be aware when writin
<_ToolRidsAreOnlyShims Condition="'$(RuntimeIdentifiers)' == '' and $(PackAsToolShimRuntimeIdentifiers) != '' ">true</_ToolRidsAreOnlyShims>
<_UserSpecifiedToolPackageRids Condition="'$(ToolPackageRuntimeIdentifiers)' != ''">$(ToolPackageRuntimeIdentifiers)</_UserSpecifiedToolPackageRids>
<_UserSpecifiedToolPackageRids Condition="'$(_UserSpecifiedToolPackageRids)' == ''">$(RuntimeIdentifiers)</_UserSpecifiedToolPackageRids>
<_HasRIDSpecificTools Condition=" '$(_UserSpecifiedToolPackageRids)' != '' ">true</_HasRIDSpecificTools>
<_HasRIDSpecificTools Condition="'$(_HasRIDSpecificTools)' == ''">false</_HasRIDSpecificTools>
<CreateRidSpecificToolPackages Condition="'$(CreateRidSpecificToolPackages)' == '' And '$(_UserSpecifiedToolPackageRids)' != '' ">true</CreateRidSpecificToolPackages>
<CreateRidSpecificToolPackages Condition="'$(CreateRidSpecificToolPackages)' == ''">false</CreateRidSpecificToolPackages>

<!-- NOTE: this line is load-bearing. This impacts Restore behaviors significantly, so we can't prevent the import of these targets _in general_. -->
<RuntimeIdentifiers Condition="'$(PackAsToolShimRuntimeIdentifiers)' != ''">$(_UserSpecifiedToolPackageRids);$(PackAsToolShimRuntimeIdentifiers)</RuntimeIdentifiers>
Expand All @@ -65,7 +65,7 @@ NOTE: This file is imported from the following contexts, so be aware when writin
<!-- We need to know if the inner builds are _intended_ to be AOT even if we then explicitly disable AOT for the outer builds.
Knowing this lets us correctly decide to create the RID-specific inner tools or not when packaging the outer tool. -->
<_InnerToolsPublishAot>false</_InnerToolsPublishAot>
<_InnerToolsPublishAot Condition="$(_HasRIDSpecificTools) and '$(PublishAot)' == 'true'">true</_InnerToolsPublishAot>
<_InnerToolsPublishAot Condition="$(CreateRidSpecificToolPackages) and '$(PublishAot)' == 'true'">true</_InnerToolsPublishAot>

<!-- determining if it's safe to change publish-related properties for this evaluation. We can only override default publishing
behavior if
Expand Down Expand Up @@ -164,7 +164,7 @@ NOTE: This file is imported from the following contexts, so be aware when writin
</PropertyGroup>

<!-- inner-build tool packages get a RID suffix -->
<PropertyGroup Condition="'$(_HasRIDSpecificTools)' != '' And '$(RuntimeIdentifier)' != ''">
<PropertyGroup Condition="$(CreateRidSpecificToolPackages) And '$(RuntimeIdentifier)' != ''">
<PackageId>$(PackageId).$(RuntimeIdentifier)</PackageId>
</PropertyGroup>
</Target>
Expand Down Expand Up @@ -390,7 +390,7 @@ NOTE: This file is imported from the following contexts, so be aware when writin
<Target Name="SetDotnetToolPackageType" Returns="$(_ToolPackageType)">

<PropertyGroup>
<_ToolPackageType Condition="'$(RuntimeIdentifier)' != '' And '$(_HasRIDSpecificTools)' != ''">DotnetToolRidPackage</_ToolPackageType>
<_ToolPackageType Condition="'$(RuntimeIdentifier)' != '' And $(CreateRidSpecificToolPackages)">DotnetToolRidPackage</_ToolPackageType>
<_ToolPackageType Condition="'$(_ToolPackageType)' == ''">DotnetTool</_ToolPackageType>
</PropertyGroup>

Expand Down Expand Up @@ -427,7 +427,7 @@ NOTE: This file is imported from the following contexts, so be aware when writin
We can't call this for AOT'd tools because we can't AOT cross-architecture and cross-platform in .NET today. -->
<Target Name="_CreateRIDSpecificToolPackages"
Condition="'$(RuntimeIdentifier)' == ''
and $(_HasRIDSpecificTools)
and $(CreateRidSpecificToolPackages)
and !$(_InnerToolsPublishAot)">
<PropertyGroup>
<_PackageRids>$(ToolPackageRuntimeIdentifiers)</_PackageRids>
Expand Down
37 changes: 37 additions & 0 deletions test/Microsoft.NET.ToolPack.Tests/GivenThatWeWantToPackAToolProject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,5 +323,42 @@ public void Given_targetplatform_set_It_should_error()
result.Should().Fail().And.HaveStdOutContaining("NETSDK1146");

}

[Fact]
public void It_packs_with_RuntimeIdentifier()
{
var testProject = new TestProject("ToolWithRuntimeIdentifier")
{
TargetFrameworks = ToolsetInfo.CurrentTargetFramework,
IsExe = true,
RuntimeIdentifier = EnvironmentInfo.GetCompatibleRid()
};
testProject.AdditionalProperties["PackAsTool"] = "true";
testProject.AdditionalProperties["ImplicitUsings"] = "enable";
testProject.AdditionalProperties["CreateRidSpecificToolPackages"] = "false";
testProject.AdditionalProperties["UseAppHost"] = "false";


var testAsset = _testAssetsManager.CreateTestProject(testProject);

var packCommand = new PackCommand(testAsset);

packCommand.Execute().Should().Pass();

packCommand.GetPackageDirectory().Should().HaveFile($"{testProject.Name}.1.0.0.nupkg");
packCommand.GetPackageDirectory().Should().NotHaveFile($"{testProject.Name}.{testProject.RuntimeIdentifier}.1.0.0.nupkg");

var nupkgPath = packCommand.GetNuGetPackage();

using (var nupkgReader = new PackageArchiveReader(nupkgPath))
{
var toolSettingsItem = nupkgReader.GetToolItems().SelectMany(g => g.Items).SingleOrDefault(i => i.Equals($"tools/{testProject.TargetFrameworks}/{testProject.RuntimeIdentifier}/DotnetToolSettings.xml"));
toolSettingsItem.Should().NotBeNull();

var toolSettingsXml = XDocument.Load(nupkgReader.GetStream(toolSettingsItem));
toolSettingsXml.Root.Attribute("Version").Value.Should().Be("1");
}

}
}
}
Loading