WIP #248 - Improving the build again

craigfowler · craigfowler · commit fdbbbe613d95 · 2026-01-17T11:57:53.000Z
* Added .NET packaging for NuGet
* Version number generation
* NuGet metadata
diff --git a/.github/workflows/dotnetCi.yml b/.github/workflows/dotnetCi.yml
@@ -13,6 +13,7 @@ jobs:
 
     env:
       RunNumber: ${{ github.run_number }}.${{ github.run_attempt }}
+      VersionSuffix: ci.${{ github.run_number }}
       SonarCloudProject: csf-dev_CSF.Screenplay
       SonarCloudUsername: craigfowler-github
       SonarCloudUrl: https://sonarcloud.io
@@ -84,7 +85,7 @@ jobs:
         /s:$PWD/.sonarqube-analysisproperties.xml
     - name: Build the solution (one TFM only for performance)
       run: dotnet build -c ${{ env.Configuration }} --no-incremental -p:TargetFrameworks=${{ env.Tfm }}
-    - name: Run .NET tests with coverage (one TFM only for performance)
+    - name: Run .NET tests with coverage
       id: dotnet_tests
       continue-on-error: true
       run: |
@@ -93,7 +94,7 @@ jobs:
           projNameArray=(${proj//// })
           projName=${projNameArray[1]}
           assemblyPath=$proj/bin/$Configuration/$Tfm/$projName.dll
-          coverlet "$assemblyPath" --target "dotnet" --targetargs "test $proj -c $Configuration --no-build -p:TargetFramework=$Tfm --logger:nunit --test-adapter-path:." -f=opencover -o="TestResults/$projName.opencover.xml"
+          coverlet "$assemblyPath" --target "dotnet" --targetargs "test $proj -c $Configuration --no-build --logger:nunit --test-adapter-path:." -f=opencover -o="TestResults/$projName.opencover.xml"
           if [ $? -ne 0 ]
           then
             echo "failures=true" >> $GITHUB_OUTPUT
@@ -150,8 +151,13 @@ jobs:
 
     # Build the apps in release mode and publish artifacts
 
-    - name: Build in release configuration
-      run: dotnet build -c Release
+    - name: Build, in release configuration
+      run: dotnet pack -p:VersionSuffix=$VersionSuffix -o packages
+    - name: Upload build result artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: Build results (NuGet)
+        path: packages/*.nupkg
   
   # buildDocs:
     # TODO: Build the docco site and package the result as an artifact, don't publish it
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,4 @@ node_modules/
 **/ScreenplayReport*
 **/TestResult.xml
 .obsidian/
+packages/
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -20,6 +20,24 @@
 			"problemMatcher": [],
 			"label": "dotnet: build (net8.0 only)"
 		},
+		{
+			"group": {
+				"kind": "build"
+			},
+			"command": "dotnet",
+			"args": ["pack", "-o", "packages"],
+			"problemMatcher": [],
+			"label": "dotnet: pack"
+		},
+		{
+			"group": {
+				"kind": "none"
+			},
+			"command": "dotnet",
+			"args": ["clean"],
+			"problemMatcher": [],
+			"label": "dotnet: clean"
+		},
 		{
 			"group": {
 				"kind": "test",
diff --git a/CSF.Screenplay.Abstractions/CSF.Screenplay.Abstractions.csproj b/CSF.Screenplay.Abstractions/CSF.Screenplay.Abstractions.csproj
@@ -1,10 +1,12 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <Import Project="..\Tools\MultiTargeting.props" />
+  <Import Project="..\Tools\Version.props" />
 
   <PropertyGroup>
     <RootNamespace>CSF.Screenplay</RootNamespace>
     <DocumentationFile>$(MSBuildProjectDirectory)\bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
+    <Description>Abstractions for CSF.Screenplay; useful for authoring Extensions or Performable/Ability logic without dependency on the full CSF.Screenplay package</Description>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/CSF.Screenplay.Docs/CSF.Screenplay.Docs.proj b/CSF.Screenplay.Docs/CSF.Screenplay.Docs.proj
@@ -17,4 +17,5 @@
     <Target Name="Clean">
         <RemoveDir Directories="$(OutputPath);$(ApiDocsPath)" />
     </Target>
+    <Target Name="Pack"><!-- Intentional no-op --></Target>
 </Project>
diff --git a/CSF.Screenplay.JsonToHtmlReport.Template/CSF.Screenplay.JsonToHtmlReport.Template.proj b/CSF.Screenplay.JsonToHtmlReport.Template/CSF.Screenplay.JsonToHtmlReport.Template.proj
@@ -4,6 +4,7 @@
     <TemplateSourceDir>$(MSBuildProjectDirectory)\src</TemplateSourceDir>
     <OutputPath>$(MSBuildProjectDirectory)\..\CSF.Screenplay.JsonToHtmlReport\template</OutputPath>
     <TemplateOutputFile>$(OutputPath)\template.html</TemplateOutputFile>
+        <IsPackable>false</IsPackable>
   </PropertyGroup>
 
   <!-- We're not explicitly using anything in this targets file but without it there's an unwanted build warning for the 'Restore' target -->
@@ -44,4 +45,6 @@
       <RemoveDir Directories="$(OutputPath)" />
   </Target>
 
+  <Target Name="Pack"><!-- Intentional no-op --></Target>
+
 </Project>
diff --git a/CSF.Screenplay.JsonToHtmlReport/CSF.Screenplay.JsonToHtmlReport.csproj b/CSF.Screenplay.JsonToHtmlReport/CSF.Screenplay.JsonToHtmlReport.csproj
@@ -1,5 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
+  <Import Project="..\Tools\Version.props" />
+
   <PropertyGroup>
     <TargetFrameworks Condition="'$(TargetFrameworks)' == ''">netcoreapp3.1;net462;netstandard2.0;net6.0;net8.0</TargetFrameworks>
     <OutputType Condition="'$(TargetFramework)' != 'netstandard2.0'">Exe</OutputType>
@@ -10,6 +12,7 @@
     <!-- It's true that netcoreapp3.1 is already long out of support and net6.0 will be soon, but these are only here for backwards compatibility.
          This project is multi-targeted and includes up-to-date TFMs -->
     <CheckEolTargetFramework>false</CheckEolTargetFramework>
+    <Description>A tool which produces human-readable HTML-format reports from the JSON-format reports created by CSF.Screenplay</Description>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/CSF.Screenplay.NUnit/CSF.Screenplay.NUnit.csproj b/CSF.Screenplay.NUnit/CSF.Screenplay.NUnit.csproj
@@ -1,12 +1,14 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <Import Project="..\Tools\MultiTargeting.props" />
+  <Import Project="..\Tools\Version.props" />
 
   <PropertyGroup>
     <RootNamespace>CSF.Screenplay</RootNamespace>
     <DocumentationFile>$(MSBuildProjectDirectory)\bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
     <IsTestProject>false</IsTestProject>
     <SonarQubeTestProject>false</SonarQubeTestProject>
+    <Description>A Test Framework Integration for CSF.Screenplay for NUnit 3.6+</Description>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/CSF.Screenplay.Selenium/CSF.Screenplay.Selenium.csproj b/CSF.Screenplay.Selenium/CSF.Screenplay.Selenium.csproj
@@ -1,10 +1,12 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <Import Project="..\Tools\MultiTargeting.props" />
+  <Import Project="..\Tools\Version.props" />
 
   <PropertyGroup>
     <RootNamespace>CSF.Screenplay.Selenium</RootNamespace>
     <DocumentationFile>$(MSBuildProjectDirectory)\bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
+    <Description>An Extension for CSF.Screenplay providing Abilities &amp; Performables for Selenium WebDriver 4.0+</Description>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/CSF.Screenplay.SpecFlow/CSF.Screenplay.SpecFlow.csproj b/CSF.Screenplay.SpecFlow/CSF.Screenplay.SpecFlow.csproj
@@ -1,13 +1,15 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <Import Project="..\Tools\MultiTargeting.props" />
+  <Import Project="..\Tools\Version.props" />
 
   <PropertyGroup>
     <RootNamespace>CSF.Screenplay</RootNamespace>
     <DocumentationFile>$(MSBuildProjectDirectory)\bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
     <IsTestProject>false</IsTestProject>
     <SonarQubeTestProject>false</SonarQubeTestProject>
     <AssemblyName>CSF.Screenplay.SpecFlowPlugin</AssemblyName>
+    <Description>A Test Framework Integration for CSF.Screenplay for the legacy SpecFlow 3.4.3+ (recommendation: Switch to Reqnroll)</Description>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/CSF.Screenplay.WebApis/CSF.Screenplay.WebApis.csproj b/CSF.Screenplay.WebApis/CSF.Screenplay.WebApis.csproj
@@ -1,12 +1,15 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
+  <Import Project="..\Tools\Version.props" />
+
   <PropertyGroup>
     <TargetFrameworks Condition="'$(TargetFrameworks)' == ''">net5.0;netstandard2.0;net462;net8.0</TargetFrameworks>
     <RootNamespace>CSF.Screenplay.WebApis</RootNamespace>
     <DocumentationFile>$(MSBuildProjectDirectory)\bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
     <!-- It's true that net5.0 is already long out of support, but it is only here so that any runtime which is net5.0 or
          above avoids pulling in unneeded packages.  This project is multi-targeted and includes up-to-date TFMs -->
     <CheckEolTargetFramework>false</CheckEolTargetFramework>
+    <Description>An Extension for CSF.Screenplay providing Abilities &amp; Performables for interacting with HTTP web API endpoints</Description>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/CSF.Screenplay/CSF.Screenplay.csproj b/CSF.Screenplay/CSF.Screenplay.csproj
@@ -1,10 +1,12 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <Import Project="..\Tools\MultiTargeting.props" />
+  <Import Project="..\Tools\Version.props" />
 
   <PropertyGroup>
     <RootNamespace>CSF.Screenplay</RootNamespace>
     <DocumentationFile>$(MSBuildProjectDirectory)\bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
+    <Description>The core CSF.Screenplay framework package</Description>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/Tests/CSF.Screenplay.Selenium.TestWebapp/CSF.Screenplay.Selenium.TestWebapp.csproj b/Tests/CSF.Screenplay.Selenium.TestWebapp/CSF.Screenplay.Selenium.TestWebapp.csproj
@@ -4,6 +4,8 @@
 
   <PropertyGroup>
     <ImplicitUsings>disable</ImplicitUsings>
+    <IsPackable>false</IsPackable>
+    <WarnOnPackingNonPackableProject>false</WarnOnPackingNonPackableProject>
   </PropertyGroup>
 
 </Project>
diff --git a/Tools/TestTfm.props b/Tools/TestTfm.props
@@ -1,7 +1,6 @@
 <Project>
     <PropertyGroup>
-        <TfmForTests>net8.0</TfmForTests>
-        <TargetFramework Condition="'$(TargetFramework)' == ''">$(TfmForTests)</TargetFramework>
+        <TargetFramework>net8.0</TargetFramework>
         <Nullable>enable</Nullable>
     </PropertyGroup>
 
diff --git a/Tools/Version.props b/Tools/Version.props
@@ -0,0 +1,17 @@
+<Project>
+    <PropertyGroup>
+        <Authors>craigfowler</Authors>
+        <PackageLicenseExpression>MIT</PackageLicenseExpression>
+        <PackageProjectUrl>https://csf-dev.github.io/CSF.Screenplay/</PackageProjectUrl>
+        <RepositoryUrl>https://github.com/csf-dev/CSF.Screenplay/</RepositoryUrl>
+        <BuildNumber Condition="'$(BuildNumber)' == ''">0</BuildNumber>
+        <VersionPrefix>2.0.0</VersionPrefix>
+        <VersionSuffix>dev.$(BuildNumber)</VersionSuffix>
+        <Version Condition="'$(VersionSuffix)' != ''">$(VersionPrefix)-$(VersionSuffix)</Version>
+        <Version Condition="'$(VersionSuffix)' == ''">$(VersionPrefix)</Version>
+        <AssemblyVersion>$(VersionPrefix).$(BuildNumber)</AssemblyVersion>
+        <FileVersion>$(AssemblyVersion)</FileVersion>
+        <InformationalVersion>$(Version)+commit$(SourceRevisionId)</InformationalVersion>
+    </PropertyGroup>
+
+</Project>
