ci: adds GitVersioning for automated versioning

Integrates Nerdbank.GitVersioning to automate versioning based on Git tags and history.

This change introduces:
- Version information using `version.json`.
- NuGet package upload of symbol packages (.snupkg) to improve debugging.
- Versioning information in the README file to improve user awareness.

This will allow pre-release versions on branches and PRs, and stable versions on tags.

Author: jeffrey-onspec

.github/workflows/ci.yml

@@ -61,7 +61,7 @@ jobs:
           $projects = Get-ChildItem .\tests -Recurse -Filter *.csproj | ForEach-Object { $_.FullName }
           foreach ($p in $projects) {
             Write-Host "Testing $p"
-            dotnet test $p -c Debug --no-build --logger "trx;LogFileName=$(Split-Path -LeafBase $p).trx"
+            dotnet test $p -c Debug --logger "trx;LogFileName=$(Split-Path -LeafBase $p).trx"
           }
 
       # Pack for validation on all events; only upload artifacts on push (not PR)
@@ -74,12 +74,13 @@ jobs:
             dotnet pack $_.FullName -c Release --no-build -o .\artifacts\nuget
           }
 
-      - name: Upload NuGet artifacts (pushes only)
-        if: github.event_name == 'push'
+      - name: Upload NuGet artifacts
         uses: actions/upload-artifact@v4
         with:
           name: nuget-packages
-          path: artifacts/nuget/*.nupkg
+          path: |
+            artifacts/nuget/*.nupkg
+            artifacts/nuget/*.snupkg
           if-no-files-found: error
           retention-days: 7
 
@@ -110,6 +111,7 @@ jobs:
 
       - name: Push packages to NuGet.org
         env:
+          # Accept either secret name: NUGET_API_KEY
           NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
         shell: pwsh
         run: |

Directory.Packages.props

@@ -3,6 +3,9 @@
     <!-- Shared package versions for src/* projects -->
     <PackageVersion Include="JetBrains.Annotations" Version="2025.2.2" />
 
+    <!-- Versioning -->
+    <PackageVersion Include="Nerdbank.GitVersioning" Version="3.6.146" />
+
     <!-- Microsoft.Extensions line (pinned newer line for net472+) -->
     <PackageVersion Include="Microsoft.Extensions.Configuration" Version="9.0.9" />
     <PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="9.0.9" />

README.md

@@ -269,7 +269,9 @@ Call `StopAsync` at shutdown to flush hosted services and logs.
 * Workflow: `.github/workflows/ci.yml`
 * Runs on Windows
 * Builds `src/*` in Release, runs tests in Debug
+* Uses Nerdbank.GitVersioning (version.json) – prerelease versions on branches/PRs; stable on tags matching `vMAJOR.MINOR.PATCH`
 * Packs NuGet on tag push (`v*`) → publishes to NuGet.org
+* Uploads `.nupkg` and `.snupkg` as workflow artifacts on PRs and pushes
 * Needs `NUGET_API_KEY` secret configured
 
 ---

eng/Directory.Build.props

@@ -12,8 +12,6 @@
     <PropertyGroup Condition="$([System.Text.RegularExpressions.Regex]::IsMatch('$(MSBuildProjectDirectory)', '[\\/]src([\\/]|$)')) AND !$([System.Text.RegularExpressions.Regex]::IsMatch('$(MSBuildProjectName)', '\\.Tests$')) AND !$([System.Text.RegularExpressions.Regex]::IsMatch('$(MSBuildProjectDirectory)', '[\\/]examples([\\/]|$)'))">
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <NoWarn>$(NoWarn);1591</NoWarn>
-        <!-- Keep AssemblyVersion stable to reduce binding churn -->
-        <AssemblyVersion>1.0.0.0</AssemblyVersion>
         <!-- Package license expression for NuGet -->
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
         <!-- Enable central package management for src projects -->
@@ -27,6 +25,11 @@
         <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     </PropertyGroup>
 
+    <!-- Add NBGV to src projects (dev dependency) -->
+    <ItemGroup Condition="$([System.Text.RegularExpressions.Regex]::IsMatch('$(MSBuildProjectDirectory)', '[\\/]src([\\/]|$)'))">
+        <PackageReference Include="Nerdbank.GitVersioning" PrivateAssets="all" />
+    </ItemGroup>
+
     <!-- Conditional strong-name signing for src in Release (only when key is present) -->
     <PropertyGroup Condition="$([System.Text.RegularExpressions.Regex]::IsMatch('$(MSBuildProjectDirectory)', '[\\/]src([\\/]|$)')) AND '$(Configuration)' == 'Release' AND Exists('$(MSBuildThisFileDirectory)HostBridge.snk')">
         <SignAssembly>true</SignAssembly>

version.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
+  "version": "1.0",
+  "publicReleaseRefSpec": [
+    "^refs/tags/v\\d+\\.\\d+\\.\\d+(?:-.*)?$"
+  ],
+  "cloudBuild": {
+    "setVersionVariables": true
+  }
+}