Improve NuGet metadata (#161)

* add repo url and license expression * remove Microsoft.SourceLink.GitHub (because included in .NET 8.0 SDK anyway) * remove <AllowedOutputExtensionsInPackageBuildOutputFolder> as it is not used with nuspec * Update 3rd party licenses * enable deterministic build * fix build * generate source package? * update CHANGELOG.md * update package texts
reqnroll · Jun 4, 2024 · f3ef016 · f3ef016
1 parent df6db18
commit f3ef016
Show file tree

Hide file tree

Showing 38 changed files with 73 additions and 406 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -136,7 +136,7 @@ jobs:
       uses: actions/upload-artifact@v4
       with:
         name: packages
-        path: "GeneratedNuGetPackages/**/*.nupkg"
+        path: "GeneratedNuGetPackages/**/*.*nupkg"
     - name: Upload TRX files
       uses: actions/upload-artifact@v4
       if: always()

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,8 @@
 
 ## Improvements:
 
-* Update [versioning policy for plugins](https://docs.reqnroll.net/latest/installation/compatibility.html#versioning-policy) and set plugin dependencies accordingly (#160).
+* Update [versioning policy for plugins](https://docs.reqnroll.net/latest/installation/compatibility.html#versioning-policy) and set plugin dependencies accordingly (#160)
+* Generate symbol packages, use deterministic build and update package metadata (#161)
 
 # v2.0.2 - 2024-05-31
 

diff --git a/Directory.Build.props b/Directory.Build.props
@@ -6,6 +6,7 @@
     <Reqnroll_Copyright>Copyright © Reqnroll</Reqnroll_Copyright>
     <Reqnroll_Authors>Reqnroll</Reqnroll_Authors>
     <Reqnroll_Owners>Reqnroll</Reqnroll_Owners>
+    <Reqnroll_Summary>Reqnroll is an open-source Cucumber-style BDD test automation framework for .NET. It has been created as a reboot of the SpecFlow project.</Reqnroll_Summary>
   </PropertyGroup>
 
   <PropertyGroup>
@@ -15,6 +16,15 @@
     <CompatibilityVersionUpperRange>3</CompatibilityVersionUpperRange>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">
+    <GitBranch Condition=" '$(GitBranch)' == ''">$(GITHUB_REF_NAME)</GitBranch>
+    <GitCommitSha Condition=" '$(GitCommitSha)' == ''">$(GITHUB_SHA)</GitCommitSha>
+    <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
+    <EmbedUntrackedSources>true</EmbedUntrackedSources>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+  </PropertyGroup>
+
   <ItemGroup>
     <None Include="$(MSBuildThisFileDirectory)/LICENSE" Pack="true" PackagePath=""/>
     <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.2">

diff --git a/Directory.Build.targets b/Directory.Build.targets
@@ -7,7 +7,10 @@
       <NuspecProperties>$(NuspecProperties);copyright=$(Reqnroll_Copyright)</NuspecProperties>
       <NuspecProperties>$(NuspecProperties);author=$(Reqnroll_Authors)</NuspecProperties>
       <NuspecProperties>$(NuspecProperties);owner=$(Reqnroll_Owners)</NuspecProperties>
+      <NuspecProperties>$(NuspecProperties);summary=$(Reqnroll_Summary)</NuspecProperties>
       <NuspecProperties>$(NuspecProperties);CompatibilityVersionRange=[$(PackageVersion),$(CompatibilityVersionUpperRange))</NuspecProperties>
+      <NuspecProperties>$(NuspecProperties);branch=$(GitBranch)</NuspecProperties>
+      <NuspecProperties>$(NuspecProperties);commit=$(GitCommitSha)</NuspecProperties>
 
       <NuspecProperties>$(NuspecProperties);Reqnroll_FullFramework_Tools_TFM=$(Reqnroll_FullFramework_Tools_TFM)</NuspecProperties>
       <NuspecProperties>$(NuspecProperties);Reqnroll_Core_Tools_TFM=$(Reqnroll_Core_Tools_TFM)</NuspecProperties>
@@ -16,14 +19,14 @@
 
   <Target Name="CleanupNupkgs" BeforeTargets="Build" >
     <ItemGroup>
-      <Nupkgs2Delete Include="$(PackageOutputAbsolutePath)\*.nupkg"/>
+      <Nupkgs2Delete Include="$(PackageOutputAbsolutePath)\*.*nupkg"/>
     </ItemGroup>
     <Delete Files="@(Nupkgs2Delete)" />
   </Target>
 
   <Target Name="CopyNupkgToFolder" AfterTargets="Pack">
     <ItemGroup>
-      <GeneratedNupkgs Include="$(PackageOutputAbsolutePath)\*.nupkg"/>
+      <GeneratedNupkgs Include="$(PackageOutputAbsolutePath)\*.*nupkg"/>
     </ItemGroup>
     <Copy SourceFiles="@(GeneratedNupkgs)" DestinationFolder="$(MSBuildThisFileDirectory)GeneratedNuGetPackages\$(Configuration)" />
   </Target>

diff --git a/Licenses/BoDi-LICENSE-Apache2.txt b/Licenses/BoDi-LICENSE-Apache2.txt
diff --git a/Licenses/System.ValueTuple-LICENSE-MIT.txt → ...umber.CucumberExpressions-LICENSE-MIT.txt b/Licenses/System.ValueTuple-LICENSE-MIT.txt → ...umber.CucumberExpressions-LICENSE-MIT.txt
@@ -1,8 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) .NET Foundation and Contributors
-
-All rights reserved.
+Copyright (c) 2016 Cucumber Ltd and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/Licenses/Newtonsoft.Json-LICENSE-MIT.md → ...es/SpecFlow.Internal.Json-LICENSE-MIT.txt b/Licenses/Newtonsoft.Json-LICENSE-MIT.md → ...es/SpecFlow.Internal.Json-LICENSE-MIT.txt
@@ -1,20 +1,20 @@
 The MIT License (MIT)
 
-Copyright (c) 2007 James Newton-King
+Copyright (c) 2018 Alex Parker
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
+this software and associated documentation files (the Software), to deal in
 the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+use, copy, modify, merge, publish, distribute, sublicense, andor sell copies of
 the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
+subject to the following conditions
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.ReqnrollPlugin.csproj b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.ReqnrollPlugin.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0</TargetFrameworks>
     <AssemblyOriginatorKeyFile>$(Reqnroll_KeyFile)</AssemblyOriginatorKeyFile>
@@ -8,20 +8,9 @@
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <NuspecFile>$(MSBuildThisFileDirectory)Reqnroll.Autofac.nuspec</NuspecFile>
 
-    <PublishRepositoryUrl>true</PublishRepositoryUrl>
-    <EmbedUntrackedSources>true</EmbedUntrackedSources>
-    <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
-
     <RootNamespace>Reqnroll.Autofac</RootNamespace>
   </PropertyGroup>
 
-  <ItemGroup>
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
-    </PackageReference>
-  </ItemGroup>
-
   <ItemGroup>
     <PackageReference Include="Autofac" Version="4.0.0" />
   </ItemGroup>

diff --git a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.nuspec b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.nuspec
@@ -10,10 +10,11 @@
     <summary>Reqnroll plugin that enables to use Autofac for resolving test dependencies.</summary>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
+    <repository type="git" url="https://github.com/reqnroll/Reqnroll.git" branch="$branch$" commit="$commit$" />
     <icon>images\reqnroll-icon.png</icon>
     <copyright>Copyright © Gaspar Nagy, Spec Solutions, $author$</copyright>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
-    <license type="file">LICENSE</license>
+    <license type="expression">BSD-3-Clause</license>
     <tags>reqnroll autofac di dependency injection</tags>
     <dependencies>
       <group targetFramework=".NETStandard2.0">

diff --git a/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec b/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec
@@ -10,9 +10,10 @@
     <summary>Package for writing custom generator extensions for Reqnroll.</summary>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
+    <repository type="git" url="https://github.com/reqnroll/Reqnroll.git" branch="$branch$" commit="$commit$" />
     <icon>images\reqnroll-icon.png</icon>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
-    <license type="file">LICENSE</license>
+    <license type="expression">BSD-3-Clause</license>
     <tags>reqnroll bdd gherkin cucumber generator</tags>
     <copyright>$copyright$</copyright>
     <dependencies>
@@ -27,8 +28,7 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.Utils.*" target="lib\netstandard2.0" />
     <file src="bin\$config$\netstandard2.0\Reqnroll.Parser.*" target="lib\netstandard2.0" />
 
-    <file src="$SolutionDir$Licenses\Gherkin-LICENSE-MIT.txt" target="Licenses" />
-    <file src="$SolutionDir$Licenses\BoDi-LICENSE-Apache2.txt" target="Licenses" />
+    <file src="$SolutionDir$\Licenses\*" target="Licenses" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />

diff --git a/...rnalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.ReqnrollPlugin.csproj b/...rnalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.ReqnrollPlugin.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0</TargetFrameworks>
     <NuspecFile>$(MSBuildThisFileDirectory)Reqnroll.ExternalData.nuspec</NuspecFile>
@@ -7,10 +7,7 @@
     <PublicSign>$(Reqnroll_PublicSign)</PublicSign>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
 
-    <PublishRepositoryUrl>true</PublishRepositoryUrl>
-    <EmbedUntrackedSources>true</EmbedUntrackedSources>
     <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
-    <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
   </PropertyGroup>
 
   <ItemGroup>