Merge pull request #3748 from nunit/issue/3745

Create NuGet source packages, snupkg
nunit · Jan 31, 2021 · 248dae7 · 248dae7
2 parents c7afecb + 41021cc
commit 248dae7
Show file tree

Hide file tree

Showing 5 changed files with 129 additions and 4 deletions.
diff --git a/build.cake b/build.cake
@@ -274,14 +274,17 @@ var FrameworkFiles = new FilePath[]
     "mock-assembly.dll",
     "mock-assembly.exe",
     "nunit.framework.dll",
+    "nunit.framework.pdb",
     "nunit.framework.xml",
     "nunit.framework.tests.dll",
     "nunit.testdata.dll",
     "nunitlite.dll",
+    "nunitlite.pdb",
     "nunitlite.tests.exe",
     "nunitlite.tests.dll",
     "slow-nunit-tests.dll",
     "nunitlite-runner.exe",
+    "nunitlite-runner.pdb",
     "nunitlite-runner.dll",
     "Microsoft.Threading.Tasks.dll",
     "Microsoft.Threading.Tasks.Extensions.Desktop.dll",
@@ -341,13 +344,35 @@ Task("PackageFramework")
         {
             Version = packageVersion,
             BasePath = CurrentImageDir,
-            OutputDirectory = PACKAGE_DIR
+            OutputDirectory = PACKAGE_DIR,
+            Symbols = true
         };
 
         NuGetPack("nuget/framework/nunit.nuspec", settings);
         NuGetPack("nuget/nunitlite/nunitlite.nuspec", settings);
     });
 
+Task("PackageFrameworkSnupkg")
+    .Description("Creates NuGet snupkg source packages of the framework")
+    .IsDependentOn("CreateImage")
+    .Does(() =>
+    {
+        CreateDirectory(PACKAGE_DIR);
+
+        var settings = new NuGetPackSettings
+        {
+            Version = packageVersion,
+            BasePath = CurrentImageDir,
+            OutputDirectory = PACKAGE_DIR,
+            Symbols = true,
+            // snupkg is not yet supported by Cake, https://github.com/cake-build/cake/issues/2362
+            ArgumentCustomization = args => args.Append("-SymbolPackageFormat snupkg")
+        };
+
+        NuGetPack("nuget/framework/nunit.snupkg.nuspec", settings);
+        NuGetPack("nuget/nunitlite/nunitlite.snupkg.nuspec", settings);
+    });
+
 Task("PackageZip")
     .Description("Creates a ZIP file of the framework")
     .IsDependentOn("CreateImage")
@@ -385,6 +410,7 @@ Task("SignPackages")
     .Description("Signs the NuGet packages")
     .IsDependentOn("InstallSigningTool")
     .IsDependentOn("PackageFramework")
+    .IsDependentOn("PackageFrameworkSnupkg")
     .Does(() =>
     {
         // Get the secret.
@@ -404,7 +430,7 @@ Task("SignPackages")
         var settings = File("./signclient.json");
 
         // Get the files to sign.
-        var files = GetFiles(string.Concat(PACKAGE_DIR, "*.nupkg"));
+        var files = GetFiles(string.Concat(PACKAGE_DIR, "*.*nupkg"));
 
         foreach(var file in files)
         {
@@ -441,6 +467,7 @@ Task("UploadArtifacts")
     .Does(() =>
     {
         UploadArtifacts(PACKAGE_DIR, "*.nupkg");
+        UploadArtifacts(PACKAGE_DIR, "*.snupkg");
         UploadArtifacts(PACKAGE_DIR, "*.zip");
     });
 
@@ -615,6 +642,7 @@ Task("Package")
     .Description("Packages all versions of the framework")
     .IsDependentOn("CheckForError")
     .IsDependentOn("PackageFramework")
+    .IsDependentOn("PackageFrameworkSnupkg")
     .IsDependentOn("PackageZip");
 
 Task("Appveyor")

diff --git a/nuget/framework/nunit.snupkg.nuspec b/nuget/framework/nunit.snupkg.nuspec
@@ -0,0 +1,38 @@
+<?xml version="1.0"?>
+<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
+  <metadata minClientVersion="3.5">
+    <id>NUnit</id>
+    <title>NUnit</title>
+    <version>$version$</version>
+    <packageTypes>
+      <packageType name="SymbolsPackage" />
+    </packageTypes>
+    <authors>Charlie Poole, Rob Prouse</authors>
+    <owners>Charlie Poole, Rob Prouse</owners>
+    <license type="expression">MIT</license>
+    <projectUrl>https://nunit.org</projectUrl>
+    <repository type="git" url="https://github.com/nunit/nunit"/>
+    <requireLicenseAcceptance>false</requireLicenseAcceptance>
+    <description>Symbols for debugging into the NUnit Framework assemblies.</description>
+    <language>en-US</language>
+    <copyright>Copyright (c) 2021 Charlie Poole, Rob Prouse</copyright>
+    <dependencies>
+      <group targetFramework="net35" />
+      <group targetFramework="net40" />
+      <group targetFramework="net45" />
+      <group targetFramework="netstandard2.0">
+        <dependency id="NETStandard.Library" version="2.0.0" />
+      </group>
+    </dependencies>
+  </metadata>
+  <files>
+    <file src="bin/net35/nunit.framework.dll" target="lib\net35" />
+    <file src="bin/net35/nunit.framework.pdb" target="lib\net35" />
+    <file src="bin/net40/nunit.framework.dll" target="lib\net40" />
+    <file src="bin/net40/nunit.framework.pdb" target="lib\net40" />
+    <file src="bin/net45/nunit.framework.dll" target="lib\net45" />
+    <file src="bin/net45/nunit.framework.pdb" target="lib\net45" />
+    <file src="bin/netstandard2.0/nunit.framework.dll" target="lib\netstandard2.0" />
+    <file src="bin/netstandard2.0/nunit.framework.pdb" target="lib\netstandard2.0" />
+  </files>
+</package>
diff --git a/nuget/nunitlite/nunitlite.snupkg.nuspec b/nuget/nunitlite/nunitlite.snupkg.nuspec
@@ -0,0 +1,55 @@
+<?xml version="1.0"?>
+<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
+  <metadata minClientVersion="3.5">
+    <id>NUnitLite</id>
+    <title>NUnitLite</title>
+    <version>$version$</version>
+    <packageTypes>
+      <packageType name="SymbolsPackage" />
+    </packageTypes>
+    <authors>Charlie Poole, Rob Prouse</authors>
+    <owners>Charlie Poole, Rob Prouse</owners>
+    <license type="expression">MIT</license>
+    <projectUrl>https://nunit.org</projectUrl>
+    <repository type="git" url="https://github.com/nunit/nunit"/>
+    <language>en-US</language>
+    <requireLicenseAcceptance>false</requireLicenseAcceptance>
+    <description>Symbols for debugging into the NUnitLite assemblies.</description>
+    <copyright>Copyright (c) 2021 Charlie Poole, Rob Prouse</copyright>
+    <dependencies>
+      <group targetFramework="net35">
+        <dependency id="NUnit" version="[$version$]" />
+      </group>
+      <group targetFramework="net40">
+        <dependency id="NUnit" version="[$version$]" />
+      </group>
+      <group targetFramework="net45">
+        <dependency id="NUnit" version="[$version$]" />
+      </group>
+      <group targetFramework="netstandard2.0">
+        <dependency id="NUnit" version="[$version$]" />
+        <dependency id="NETStandard.Library" version="2.0.0" />
+      </group>
+    </dependencies>
+  </metadata>
+  <files>
+    <file src="bin/net35/nunitlite.pdb" target="lib\net35" />
+    <file src="bin/net35/nunitlite.dll" target="lib\net35" />
+    <file src="bin/net40/nunitlite.pdb" target="lib\net40" />
+    <file src="bin/net40/nunitlite.dll" target="lib\net40" />
+    <file src="bin/net45/nunitlite.pdb" target="lib\net45" />
+    <file src="bin/net45/nunitlite.dll" target="lib\net45" />
+    <file src="bin/netstandard2.0/nunitlite.pdb" target="lib\netstandard2.0" />
+    <file src="bin/netstandard2.0/nunitlite.dll" target="lib\netstandard2.0" />
+    <file src="bin/net35/nunitlite-runner.pdb" target="tools\net35" />
+    <file src="bin/net35/nunitlite-runner.exe" target="tools\net35" />
+    <file src="bin/net40/nunitlite-runner.pdb" target="tools\net40" />
+    <file src="bin/net40/nunitlite-runner.exe" target="tools\net40" />
+    <file src="bin/net45/nunitlite-runner.pdb" target="tools\net45" />
+    <file src="bin/net45/nunitlite-runner.exe" target="tools\net45" />
+    <file src="bin/netcoreapp2.1/nunitlite-runner.pdb" target="tools\netcoreapp2.1" />
+    <file src="bin/netcoreapp2.1/nunitlite-runner.dll" target="tools\netcoreapp2.1" />
+    <file src="bin/netcoreapp3.1/nunitlite-runner.pdb" target="tools\netcoreapp3.1" />
+    <file src="bin/netcoreapp3.1/nunitlite-runner.dll" target="tools\netcoreapp3.1" />
+  </files>
+</package>
diff --git a/nunit.sln b/nunit.sln
@@ -44,12 +44,14 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "framework", "framework", "{CE68713C-2E19-43E8-9333-6ED817110D52}"
 	ProjectSection(SolutionItems) = preProject
 		nuget\framework\nunit.nuspec = nuget\framework\nunit.nuspec
+		nuget\framework\nunit.snupkg.nuspec = nuget\framework\nunit.snupkg.nuspec
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "nunitlite", "nunitlite", "{8D43A220-7FE8-4214-BBB4-08568B88C7AA}"
 	ProjectSection(SolutionItems) = preProject
 		nuget\nunitlite\install.ps1 = nuget\nunitlite\install.ps1
 		nuget\nunitlite\nunitlite.nuspec = nuget\nunitlite\nunitlite.nuspec
+		nuget\nunitlite\nunitlite.snupkg.nuspec = nuget\nunitlite\nunitlite.snupkg.nuspec
 		nuget\nunitlite\Program.cs = nuget\nunitlite\Program.cs
 		nuget\nunitlite\Program.vb = nuget\nunitlite\Program.vb
 	EndProjectSection

diff --git a/src/NUnitFramework/Directory.Build.props b/src/NUnitFramework/Directory.Build.props
@@ -29,12 +29,14 @@
   <!-- We always want a good debugging experience in tests -->
   <PropertyGroup>
     <Optimize>false</Optimize>
-    <DebugType>embedded</DebugType>
+    <DebugType>portable</DebugType>
     <DebugSymbols>true</DebugSymbols>
-    <EmbedAllSources>true</EmbedAllSources>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <EmbedUntrackedSources>true</EmbedUntrackedSources>
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
     <PackageReference Include="DotNetAnalyzers.DocumentationAnalyzers" Version="1.0.0-beta.59" PrivateAssets="all" />
   </ItemGroup>