Set up package publishing and adjust a bunch of project-related stuff for it

Author: RudyTheDev

.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish NuGet Package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Set up .NET
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: '8.x'
+
+    - name: Restore dependencies
+      run: dotnet restore
+
+    - name: Build the project
+      run: dotnet build --configuration Release --no-restore
+
+    - name: Pack the project
+      run: dotnet pack --configuration Release --no-build --output ./nupkg
+
+    - name: Publish to GitHub Packages
+      run: dotnet nuget push ./nupkg/*.nupkg --source "https://nuget.pkg.github.com/${{ github.repository_owner }}/index.json" --api-key ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Publish to NuGet.org
+      run: dotnet nuget push ./nupkg/*.nupkg --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }}

.github/workflows/test.yml

@@ -1,27 +1,29 @@
-# This workflow will build the solution and run tests
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-net
-
-name: Tests
+name: Run Unit Tests
 
 on:
   push:
   pull_request:
-    branches: 
+    branches:
       - main
 
 jobs:
   build_and_test:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - name: Checkout code
+      uses: actions/checkout@v3
+    
     - name: Setup .NET
       uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: 7.0.x
+        dotnet-version: 8.0.x
+        
     - name: Restore dependencies
       run: dotnet restore
+      
     - name: Build
       run: dotnet build --no-restore --configuration Release
+      
     - name: Test
       run: dotnet test --no-build --configuration Release --verbosity normal

Benchmarks/Benchmarks.csproj

@@ -12,6 +12,7 @@
 
     <ItemGroup>
       <PackageReference Include="BenchmarkDotNet" Version="0.14.0" />
+      <PackageReference Include="JetBrains.Annotations" Version="2024.2.0" />
     </ItemGroup>
 
     <ItemGroup>

NuGet.config

@@ -0,0 +1,6 @@
+<configuration>
+  <packageSources>
+    <add key="GitHub" value="https://nuget.pkg.github.com/RudyTheDev/index.json" />
+    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
+  </packageSources>
+</configuration>

README.md

@@ -14,7 +14,6 @@ The key differences from the [original VoronoiLib repo](https://github.com/Zalgo
 
 Known issues:
 * The algorithm uses a lot of allocations, forcing garbage collection
-* There is no visual output/example since the original used MonoGame
 
 # Examples
 
@@ -112,7 +111,7 @@ A very simple MonoGame example is included in `MonoGameExample` project:
 
 # Dependencies
 
-The main library is compiled for .NET (Core) 6.0 and .NET Standard 2.0 at C# 8.0 and targets compatible OSes - Windows, Linux & macOS - and frameworks like Xamarin, Mono, UWP, or Unity.
+The main library is compiled for .NET 8.0 and .NET Standard 2.0 and targets compatible OSes - Windows, Linux & macOS - and .NET and Mono frameworks - Xamarin, Mono, UWP, Unity, etc.
 
 # Credits
 

SharpVoronoiLib/SharpVoronoiLib.csproj

@@ -1,6 +1,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
+        <Version>1.0.3</Version>
+        <AssemblyVersion>1.0.0</AssemblyVersion>
         <ImplicitUsings>disable</ImplicitUsings>
         <Nullable>enable</Nullable>
         <LangVersion>12</LangVersion>
@@ -13,12 +15,16 @@
         <PackageLicenseUrl>https://github.com/RudyTheDev/SharpVoronoiLib/blob/main/License.md</PackageLicenseUrl>
         <RepositoryUrl>https://github.com/RudyTheDev/SharpVoronoiLib</RepositoryUrl>
         <RepositoryType>git</RepositoryType>
-        <PackageTags>voronoi lloyds fortune's</PackageTags>
-        <PackageReleaseNotes>First release</PackageReleaseNotes>
+        <PackageTags>voronoi lloyds fortune's tessellation </PackageTags>
+        <PackageReleaseNotes></PackageReleaseNotes>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
     <ItemGroup>
-      <PackageReference Include="JetBrains.Annotations" Version="2024.2.0" />
+        <PackageReference Include="JetBrains.Annotations" Version="2024.2.0">
+            <PrivateAssets>all</PrivateAssets>
+        </PackageReference>
+        <None Include="..\README.md" Pack="true" PackagePath="\"/>
     </ItemGroup>
 
 </Project>

UnitTests/UnitTests.csproj

@@ -11,6 +11,7 @@
     </PropertyGroup>
 
     <ItemGroup>
+        <PackageReference Include="JetBrains.Annotations" Version="2024.2.0" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
         <PackageReference Include="NUnit" Version="4.1.0" />
         <PackageReference Include="NUnit3TestAdapter" Version="4.6.0" />