Use csproj as pack input instead of nuspec

Now that sourcelink is a native part of the .NET SDK, Arcade doesn't bring sourcelink packages in anymore. Now that the cyclic package dependency is avoided, these projects don't need to use nuspecs anymore. This removes custom infrastructure and allows better source build controls. I diffed the produced packages and the content in the .NETCoreApp folder is identical (a deps.json file is added but that's recommended by msbuild for build tasks these days). The .NET Framework output is significantly different as it now includes all dependencies that aren't supplied by the MSBuild inside Visual Studio.
dotnet · Feb 1, 2024 · 481ba16 · 481ba16
1 parent 006ca8c
commit 481ba16
Show file tree

Hide file tree

Showing 64 changed files with 309 additions and 437 deletions.
diff --git a/eng/BuildTask.targets b/eng/BuildTask.targets
@@ -0,0 +1,120 @@
+<!-- Copied from arcade with small modifications. -->
+<Project>
+
+  <PropertyGroup>
+    <IncludeBuildOutput>false</IncludeBuildOutput>
+    <IsPackable>true</IsPackable>
+    <!-- Build Tasks should not include any dependencies -->
+    <SuppressDependenciesWhenPacking Condition="'$(SuppressDependenciesWhenPacking)' == ''">true</SuppressDependenciesWhenPacking>
+    <!-- Build Tasks should have this set per https://github.com/dotnet/arcade/blob/master/Documentation/CorePackages/Versioning.md#recommended-settings -->
+    <AutoGenerateAssemblyVersion>true</AutoGenerateAssemblyVersion>
+    <BuildTaskTargetFolder Condition="'$(BuildTaskTargetFolder)' == ''">tools</BuildTaskTargetFolder>
+    <PackTasks Condition="'$(PackTasks)' == ''">true</PackTasks>
+    <TargetsForTfmSpecificContentInPackage Condition="'$(PackTasks)' == 'true'">$(TargetsForTfmSpecificContentInPackage);_AddBuildOutputToPackageCore;_AddBuildOutputToPackageDesktop</TargetsForTfmSpecificContentInPackage>
+    <DevelopmentDependency>true</DevelopmentDependency>
+    <!-- Some target frameworks declared in the dependencies group of the nuspec and the lib/ref folder do not have exact matches in the other location. -->
+    <NoWarn>$(NoWarn);NU5128</NoWarn>
+  </PropertyGroup>
+
+  <!--
+    Default to including all *.props and *.targets files
+    from the project directory into the NuGet package root
+  -->
+  <ItemGroup Condition="'$(EnableDefaultItems)' != 'false'">
+    <None Condition="'$(EnableDefaultNoneItems)' != 'false'"
+          Include="**/*.props;**/*.targets"
+          Pack="true"
+          PackagePath="%(RecursiveDir)%(Filename)%(Extension)" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include="$(RepoRoot)License.txt" PackagePath="LICENSE.txt" Pack="true"/>
+  </ItemGroup>
+
+  <!-- Don't include assemblies that MSBuild ships with. -->
+  <ItemGroup>
+    <PackageReference Update="Microsoft.Build" Publish="false" />
+    <PackageReference Update="Microsoft.Build.Framework" Publish="false" />
+    <PackageReference Update="Microsoft.Build.Tasks.Core" Publish="false" />
+    <PackageReference Update="Microsoft.Build.Utilities.Core" Publish="false" />
+    <PackageReference Update="Microsoft.NET.StringTools" Publish="false" />
+    <PackageReference Update="System.Collections.Immutable" Publish="false" />
+  </ItemGroup>
+
+  <!-- Don't include assemblies that are provided by the SDK, next to MSBuild. -->
+  <ItemGroup Condition="'$(TargetFrameworkIdentifier)' == '.NETCoreApp' and '$(SkipSDKInboxPublishExcludes)' != 'true'">
+    <PackageReference Update="Newtonsoft.Json" Publish="false" />
+    <PackageReference Update="NuGet.Commands" Publish="false" />
+    <PackageReference Update="NuGet.Common" Publish="false" />
+    <PackageReference Update="NuGet.Configuration" Publish="false" />
+    <PackageReference Update="NuGet.Frameworks" Publish="false" />
+    <PackageReference Update="NuGet.Packaging" Publish="false" />
+    <PackageReference Update="NuGet.ProjectModel" Publish="false" />
+    <PackageReference Update="NuGet.Versioning" Publish="false" />
+  </ItemGroup>
+
+  <!-- Don't include assemblies that are inbox in Desktop MSBuild -->
+  <ItemGroup Condition="'$(TargetFrameworkIdentifier)' == '.NETFramework'">
+    <PackageReference Update="System.Buffers" Publish="false" />
+    <PackageReference Update="System.Memory" Publish="false" />
+    <PackageReference Update="System.Numerics.Vectors" Publish="false" />
+    <PackageReference Update="System.Reflection.Metadata" Publish="false" />
+    <PackageReference Update="System.Reflection.MetadataLoadContext" Publish="false" />
+    <PackageReference Update="System.Runtime.CompilerServices.Unsafe" Publish="false" />
+    <PackageReference Update="System.Security.Cryptography.Xml" Publish="false" />
+    <PackageReference Update="System.Text.Encodings.Web" Publish="false" />
+    <PackageReference Update="System.Text.Json" Publish="false" />
+    <PackageReference Update="System.Threading.Tasks.Dataflow" Publish="false" />
+    <PackageReference Update="System.Threading.Tasks.Extensions" Publish="false" />
+    <PackageReference Update="System.ValueTuple" Publish="false" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <!--
+      Update all PackageReference items to default Publish to true.
+      This forces the publish output to contain the dlls.
+     -->
+    <PackageReference Update="@(PackageReference)">
+      <Publish Condition="'%(PackageReference.Publish)' == ''">true</Publish>
+      <ExcludeAssets Condition="'%(PackageReference.Publish)' == 'false'">runtime</ExcludeAssets>
+    </PackageReference>
+
+    <!--
+      Update all Reference items to have Pack="false"
+      This removes the frameworkDependency nodes from the generated nuspec
+    -->
+    <Reference Update="@(Reference)"
+               Pack="false" />
+  </ItemGroup>
+
+  <!-- Desktop MSBuild compatibilty -->
+  <ItemGroup Condition="'$(TargetFrameworkIdentifier)' == '.NETFramework'">
+    <PackageReference Update="System.Text.Json" Version="7.0.1" />
+    <PackageReference Update="Microsoft.Extensions.Logging.Console" Version="7.0.0" />
+    <PackageReference Update="Microsoft.Extensions.DependencyModel" Version="7.0.0" />
+    <PackageReference Update="System.Collections.Immutable" Version="7.0.0" />
+    <PackageReference Update="System.Reflection.Metadata" Version="7.0.0" />
+  </ItemGroup>
+
+  <!-- Publish .NET Core assets and include them in the package under $(BuildTaskTargetFolder) directory. -->
+  <Target Name="_AddBuildOutputToPackageCore" DependsOnTargets="Publish" Condition="'$(TargetFrameworkIdentifier)' == '.NETCoreApp'">
+    <PropertyGroup>
+      <BuildTaskTargetTfmSpecificFolder Condition="'$(BuildTaskTargetTfmSpecificFolder)' == ''">net</BuildTaskTargetTfmSpecificFolder>
+    </PropertyGroup>
+    <ItemGroup>
+      <TfmSpecificPackageFile Include="$(PublishDir)**"
+                              PackagePath="$(BuildTaskTargetFolder)/$(BuildTaskTargetTfmSpecificFolder)/%(RecursiveDir)%(FileName)%(Extension)"/>
+    </ItemGroup>
+  </Target>
+
+  <!-- Include .NET Framework build outputs in the package under $(BuildTaskTargetFolder) directory. -->
+  <Target Name="_AddBuildOutputToPackageDesktop" Condition="'$(TargetFrameworkIdentifier)' != '.NETCoreApp'">
+    <PropertyGroup>
+      <BuildTaskTargetTfmSpecificFolder Condition="'$(BuildTaskTargetTfmSpecificFolder)' == ''">netframework</BuildTaskTargetTfmSpecificFolder>
+    </PropertyGroup>
+    <ItemGroup>
+      <TfmSpecificPackageFile Include="$(OutputPath)**" PackagePath="$(BuildTaskTargetFolder)/$(BuildTaskTargetTfmSpecificFolder)/%(RecursiveDir)%(FileName)%(Extension)"/>
+    </ItemGroup>
+  </Target>
+
+</Project>
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -1,4 +1,5 @@
 <Project>
+
   <Import Project="Sdk.props" Sdk="Microsoft.DotNet.Arcade.Sdk" />
 
   <PropertyGroup>
@@ -9,11 +10,5 @@
 
     <IncludeSymbols Condition="'$(DebugType)' != 'embedded' and '$(UsingMicrosoftNoTargetsSdk)' != 'true'">true</IncludeSymbols>
   </PropertyGroup>
-
-  <!--
-    Workaround for https://github.com/dotnet/sdk/issues/2232: GenerateDepsFile throws ArgumentException.
-  -->
-  <PropertyGroup Condition="'$(IsTestProject)' != 'true'">
-    <GenerateDependencyFile>false</GenerateDependencyFile>
-  </PropertyGroup>
+
 </Project>
diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets
@@ -1,25 +1,7 @@
 <Project>
 
   <Import Project="Sdk.targets" Sdk="Microsoft.DotNet.Arcade.Sdk" />
-
-  <!-- TODO: Remove when Arcade offers an in-built way to filter out anything other than NetCurrent: https://github.com/dotnet/arcade/issues/13390. -->
-  <PropertyGroup>
-    <TargetFrameworks Condition="'$(TargetFrameworks)' != '' and '$(DotNetBuildSourceOnly)' == 'true'">$(NetCurrent)</TargetFrameworks>
-  </PropertyGroup>
-
-  <ItemGroup>
-    <NuspecProperty Include="DesktopTfm=net472"/>
-    <NuspecProperty Include="CoreTfm=$(NetCurrent)" Condition="'$(DotNetBuildSourceOnly)' == 'true'"/>
-    <NuspecProperty Include="CoreTfm=$(NetMinimum)" Condition="'$(DotNetBuildSourceOnly)' != 'true'"/>
-  </ItemGroup>
-
-  <!-- 
-    Workaround for https://github.com/NuGet/Home/issues/6754: cyclic dependency.
-  -->
-  <PropertyGroup>
-    <_ProjectDefinedPackageId>$(PackageId)</_ProjectDefinedPackageId>
-    <PackageId>*fake_packageid_for_project_$(MSBuildProjectName)*</PackageId>
-  </PropertyGroup>
+  <Import Project="$(RepositoryEngineeringDir)BuildTask.targets" Condition="'$(IsBuildTaskProject)' == 'true'" />
 
   <!-- 
     Workaround for https://github.com/Microsoft/msbuild/issues/2527.
@@ -28,16 +10,4 @@
     <ImplicitlyExpandNETStandardFacades Condition="'$(TargetFrameworkIdentifier)' == '.NETFramework'">false</ImplicitlyExpandNETStandardFacades>
   </PropertyGroup>
 
-  <!--
-     Workaround for cyclic package reference. PackageId is set to ain invalid value above (in evaluation phase to be picked up by Restore),
-     then updated to the actual value before Pack target and SourceLink source package generation target.
-  -->
-  <Target Name="_UpdatePackageId" BeforeTargets="$(PackDependsOn);InitializeSourceControlInformation" >
-    <PropertyGroup>
-      <PackageId>$(_ProjectDefinedPackageId)</PackageId>
-      <PackageId Condition="'$(PackageId)' == ''">$(AssemblyName)</PackageId>
-      <PackageId Condition="'$(PackageId)' == ''">$(MSBuildProjectName)</PackageId>
-    </PropertyGroup>
-  </Target>
-
 </Project>
diff --git a/src/Microsoft.Build.StandardCI/Microsoft.Build.StandardCI.csproj b/src/Microsoft.Build.StandardCI/Microsoft.Build.StandardCI.csproj
@@ -2,20 +2,11 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
-    <IsPackable>true</IsPackable>
     <SuppressFinalPackageVersion>true</SuppressFinalPackageVersion>
     <PackageDescription>Standard CI targets.</PackageDescription>
     <PackageTags>Standard CI msbuild targets</PackageTags>
-    <DevelopmentDependency>true</DevelopmentDependency>
-    <!-- This is a content only package. -->
-    <NoWarn>$(NoWarn);NU5128</NoWarn>
-    <SuppressDependenciesWhenPacking>true</SuppressDependenciesWhenPacking>
+    <IsBuildTaskProject>true</IsBuildTaskProject>
+    <PackTasks>false</PackTasks>
   </PropertyGroup>
 
-  <ItemGroup>
-    <None Include="build\Microsoft.Build.StandardCI.props"
-          Pack="true"
-          PackagePath="build" />
-  </ItemGroup>
-
 </Project>
diff --git a/src/Microsoft.Build.StandardCI/Microsoft.Build.StandardCI.nuspec b/src/Microsoft.Build.StandardCI/Microsoft.Build.StandardCI.nuspec
diff --git a/src/Microsoft.Build.StandardCI/buildTransitive/Microsoft.Build.StandardCI.props b/src/Microsoft.Build.StandardCI/buildTransitive/Microsoft.Build.StandardCI.props
@@ -0,0 +1,4 @@
+<!-- Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. See the License.txt file in the project root for more information. -->
+<Project>
+  <Import Project="..\build\$(MSBuildThisFileName).props"/>
+</Project>
diff --git a/src/Microsoft.Build.Tasks.Git.UnitTests/Microsoft.Build.Tasks.Git.UnitTests.csproj b/src/Microsoft.Build.Tasks.Git.UnitTests/Microsoft.Build.Tasks.Git.UnitTests.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net472;$(NetCurrent)</TargetFrameworks>
+    <TargetFrameworks>$(NetToolCurrent);$(NetFrameworkToolCurrent)</TargetFrameworks>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/Microsoft.Build.Tasks.Git/Microsoft.Build.Tasks.Git.csproj b/src/Microsoft.Build.Tasks.Git/Microsoft.Build.Tasks.Git.csproj
@@ -1,17 +1,10 @@
 <Project Sdk="Microsoft.NET.Sdk">
-  <PropertyGroup>
-    <TargetFrameworks>net472;$(NetMinimum);$(NetCurrent)</TargetFrameworks>
-    <AutoGenerateAssemblyVersion>true</AutoGenerateAssemblyVersion>
-
-    <!-- NuGet: Using an explicit nuspec file to customize TFM directory -->
-    <IsPackable>true</IsPackable>
-    <NuspecFile>$(MSBuildProjectName).nuspec</NuspecFile>
-    <NuspecBasePath>$(OutputPath)</NuspecBasePath>
 
+  <PropertyGroup>
+    <TargetFrameworks>$(NetToolMinimum);$(NetFrameworkToolCurrent)</TargetFrameworks>
     <PackageDescription>MSBuild tasks providing git repository information.</PackageDescription>
     <PackageTags>MSBuild Tasks source control git</PackageTags>
-    <DevelopmentDependency>true</DevelopmentDependency>
-    <SuppressDependenciesWhenPacking>true</SuppressDependenciesWhenPacking>
+    <IsBuildTaskProject>true</IsBuildTaskProject>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.Build" Version="$(MicrosoftBuildVersion)" />
@@ -25,4 +18,5 @@
     <InternalsVisibleTo Include="Microsoft.Build.Tasks.Git.UnitTests" />
     <InternalsVisibleTo Include="Microsoft.SourceLink.Git.IntegrationTests" />
   </ItemGroup>
+
 </Project>
diff --git a/src/Microsoft.Build.Tasks.Git/Microsoft.Build.Tasks.Git.nuspec b/src/Microsoft.Build.Tasks.Git/Microsoft.Build.Tasks.Git.nuspec
diff --git a/src/Microsoft.Build.Tasks.Git/build/Microsoft.Build.Tasks.Git.props b/src/Microsoft.Build.Tasks.Git/build/Microsoft.Build.Tasks.Git.props
@@ -1,7 +1,7 @@
 <!-- Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. See the License.txt file in the project root for more information. -->
 <Project>
   <PropertyGroup>
-    <MicrosoftBuildTasksGitAssemblyFile Condition="'$(MSBuildRuntimeType)' != 'Core'">$(MSBuildThisFileDirectory)..\tools\net472\Microsoft.Build.Tasks.Git.dll</MicrosoftBuildTasksGitAssemblyFile>
-    <MicrosoftBuildTasksGitAssemblyFile Condition="'$(MSBuildRuntimeType)' == 'Core'">$(MSBuildThisFileDirectory)..\tools\core\Microsoft.Build.Tasks.Git.dll</MicrosoftBuildTasksGitAssemblyFile>
+    <MicrosoftBuildTasksGitAssemblyFile Condition="'$(MSBuildRuntimeType)' != 'Core'">$(MSBuildThisFileDirectory)..\tools\netframework\Microsoft.Build.Tasks.Git.dll</MicrosoftBuildTasksGitAssemblyFile>
+    <MicrosoftBuildTasksGitAssemblyFile Condition="'$(MSBuildRuntimeType)' == 'Core'">$(MSBuildThisFileDirectory)..\tools\net\Microsoft.Build.Tasks.Git.dll</MicrosoftBuildTasksGitAssemblyFile>
   </PropertyGroup>
 </Project>
diff --git a/src/Microsoft.Build.Tasks.Git/buildTransitive/Microsoft.Build.Tasks.Git.props b/src/Microsoft.Build.Tasks.Git/buildTransitive/Microsoft.Build.Tasks.Git.props
@@ -0,0 +1,4 @@
+<!-- Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. See the License.txt file in the project root for more information. -->
+<Project>
+  <Import Project="..\build\$(MSBuildThisFileName).props"/>
+</Project>
diff --git a/src/Microsoft.Build.Tasks.Git/buildTransitive/Microsoft.Build.Tasks.Git.targets b/src/Microsoft.Build.Tasks.Git/buildTransitive/Microsoft.Build.Tasks.Git.targets
@@ -0,0 +1,4 @@
+<!-- Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. See the License.txt file in the project root for more information. -->
+<Project>
+  <Import Project="..\build\$(MSBuildThisFileName).targets"/>
+</Project>
diff --git a/src/Microsoft.Build.Tasks.Tfvc/Microsoft.Build.Tasks.Tfvc.csproj b/src/Microsoft.Build.Tasks.Tfvc/Microsoft.Build.Tasks.Tfvc.csproj
@@ -1,18 +1,11 @@
 <Project Sdk="Microsoft.NET.Sdk">
+
   <PropertyGroup>
-    <TargetFramework>net472</TargetFramework>
-    <AutoGenerateAssemblyVersion>true</AutoGenerateAssemblyVersion>
+    <TargetFramework>$(NetFrameworkToolCurrent)</TargetFramework>
     <SuppressFinalPackageVersion>true</SuppressFinalPackageVersion>
-
-    <!-- NuGet: Using an explicit nuspec file to customize TFM directory -->
-    <IsPackable>true</IsPackable>
-    <NuspecFile>$(MSBuildProjectName).nuspec</NuspecFile>
-    <NuspecBasePath>$(OutputPath)</NuspecBasePath>
-
     <PackageDescription>MSBuild tasks providing TFVC repository information.</PackageDescription>
     <PackageTags>MSBuild Tasks TFVC source link</PackageTags>
-    <DevelopmentDependency>true</DevelopmentDependency>
-    <SuppressDependenciesWhenPacking>true</SuppressDependenciesWhenPacking>
+    <IsBuildTaskProject>true</IsBuildTaskProject>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.Build" Version="$(MicrosoftBuildVersion)" />
@@ -22,4 +15,5 @@
   <ItemGroup>
     <Compile Include="..\Common\Utilities\*.cs" Link="Common\%(FileName).cs" />
   </ItemGroup>
+
 </Project>
diff --git a/src/Microsoft.Build.Tasks.Tfvc/Microsoft.Build.Tasks.Tfvc.nuspec b/src/Microsoft.Build.Tasks.Tfvc/Microsoft.Build.Tasks.Tfvc.nuspec
diff --git a/src/Microsoft.Build.Tasks.Tfvc/build/Microsoft.Build.Tasks.Tfvc.props b/src/Microsoft.Build.Tasks.Tfvc/build/Microsoft.Build.Tasks.Tfvc.props
@@ -1,6 +1,6 @@
 <!-- Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. See the License.txt file in the project root for more information. -->
 <Project>
   <PropertyGroup>
-    <MicrosoftBuildTasksTfvcAssemblyFile>$(MSBuildThisFileDirectory)..\tools\net472\Microsoft.Build.Tasks.Tfvc.dll</MicrosoftBuildTasksTfvcAssemblyFile>
+    <MicrosoftBuildTasksTfvcAssemblyFile>$(MSBuildThisFileDirectory)..\tools\netframework\Microsoft.Build.Tasks.Tfvc.dll</MicrosoftBuildTasksTfvcAssemblyFile>
   </PropertyGroup>
 </Project>
diff --git a/src/Microsoft.Build.Tasks.Tfvc/buildTransitive/Microsoft.Build.Tasks.Tfvc.props b/src/Microsoft.Build.Tasks.Tfvc/buildTransitive/Microsoft.Build.Tasks.Tfvc.props
@@ -0,0 +1,4 @@
+<!-- Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. See the License.txt file in the project root for more information. -->
+<Project>
+  <Import Project="..\build\$(MSBuildThisFileName).props"/>
+</Project>
diff --git a/src/Microsoft.Build.Tasks.Tfvc/buildTransitive/Microsoft.Build.Tasks.Tfvc.targets b/src/Microsoft.Build.Tasks.Tfvc/buildTransitive/Microsoft.Build.Tasks.Tfvc.targets
@@ -0,0 +1,4 @@
+<!-- Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. See the License.txt file in the project root for more information. -->
+<Project>
+  <Import Project="..\build\$(MSBuildThisFileName).targets"/>
+</Project>
diff --git a/...ureDevOpsServer.Git.UnitTests/Microsoft.SourceLink.AzureDevOpsServer.Git.UnitTests.csproj b/...ureDevOpsServer.Git.UnitTests/Microsoft.SourceLink.AzureDevOpsServer.Git.UnitTests.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net472;$(NetCurrent)</TargetFrameworks>
+    <TargetFrameworks>$(NetToolCurrent);$(NetFrameworkToolCurrent)</TargetFrameworks>
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="..\SourceLink.AzureDevOpsServer.Git\Microsoft.SourceLink.AzureDevOpsServer.Git.csproj" />