Enable NuGet push for stable JsonApiDotNetCore with OpenAPI packages in preview

Author: bkoelman

.github/workflows/build.yml

@@ -72,14 +72,14 @@ jobs:
             $versionSuffix = $segments.Length -eq 1 ? '' : $segments[1..$($segments.Length - 1)] -join '-'
 
             [xml]$xml = Get-Content Directory.Build.props
-            $configuredVersionPrefix = $xml.Project.PropertyGroup.JsonApiDotNetCoreVersionPrefix | Select-Object -First 1
+            $configuredVersionPrefix = $xml.Project.PropertyGroup.VersionPrefix | Select-Object -First 1
 
             if ($configuredVersionPrefix -ne $versionPrefix) {
                 Write-Error "Version prefix from git release tag '$versionPrefix' does not match version prefix '$configuredVersionPrefix' stored in Directory.Build.props."
                 # To recover from this:
                 # - Delete the GitHub release
                 # - Run: git push --delete origin the-invalid-tag-name
-                # - Adjust JsonApiDotNetCoreVersionPrefix in Directory.Build.props, commit and push
+                # - Adjust VersionPrefix in Directory.Build.props, commit and push
                 # - Recreate the GitHub release
             }
         }
@@ -284,4 +284,4 @@ jobs:
         NUGET_ORG_API_KEY: ${{ secrets.NUGET_ORG_API_KEY }}
       shell: pwsh
       run: |
-        dotnet nuget push "$env:GITHUB_WORKSPACE/packages/*.nupkg" --api-key "$env:NUGET_ORG_API_KEY" --source 'nuget.org'
+        dotnet nuget push "$env:GITHUB_WORKSPACE/packages/*.nupkg" --api-key "$env:NUGET_ORG_API_KEY" --source 'nuget.org' --skip-duplicate

Build.ps1

@@ -1,5 +1,3 @@
-$versionSuffix="pre"
-
 function VerifySuccessExitCode {
     if ($LastExitCode -ne 0) {
         throw "Command failed with exit code $LastExitCode."
@@ -16,7 +14,7 @@ Remove-Item -Recurse -Force * -Include coverage.cobertura.xml
 dotnet tool restore
 VerifySuccessExitCode
 
-dotnet build --configuration Release /p:VersionSuffix=$versionSuffix
+dotnet build --configuration Release
 VerifySuccessExitCode
 
 dotnet test --no-build --configuration Release --verbosity quiet --collect:"XPlat Code Coverage"
@@ -25,5 +23,5 @@ VerifySuccessExitCode
 dotnet reportgenerator -reports:**\coverage.cobertura.xml -targetdir:artifacts\coverage -filefilters:-*.g.cs
 VerifySuccessExitCode
 
-dotnet pack --no-build --configuration Release --output artifacts/packages /p:VersionSuffix=$versionSuffix
+dotnet pack --no-build --configuration Release --output artifacts/packages
 VerifySuccessExitCode

Directory.Build.props

@@ -9,7 +9,9 @@
     <AnalysisMode>Recommended</AnalysisMode>
     <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)CodingGuidelines.ruleset</CodeAnalysisRuleSet>
     <RunSettingsFilePath>$(MSBuildThisFileDirectory)tests.runsettings</RunSettingsFilePath>
-    <JsonApiDotNetCoreVersionPrefix>5.6.1</JsonApiDotNetCoreVersionPrefix>
+    <VersionPrefix>5.6.1</VersionPrefix>
+    <VersionSuffix>pre</VersionSuffix>
+    <OpenApiPreviewNumber>1</OpenApiPreviewNumber>
     <NuGetAuditMode>direct</NuGetAuditMode>
     <NoWarn>$(NoWarn);NETSDK1215</NoWarn>
   </PropertyGroup>

src/JsonApiDotNetCore.Annotations/JsonApiDotNetCore.Annotations.csproj

@@ -9,7 +9,6 @@
   <Import Project="..\..\package-versions.props" />
 
   <PropertyGroup>
-    <VersionPrefix>$(JsonApiDotNetCoreVersionPrefix)</VersionPrefix>
     <PackageTags>jsonapidotnetcore;jsonapi;json:api;dotnet;asp.net;rest;web-api</PackageTags>
     <Description>Annotations for JsonApiDotNetCore, a framework for building JSON:API compliant REST APIs using ASP.NET and Entity Framework Core.</Description>
     <Authors>json-api-dotnet</Authors>

src/JsonApiDotNetCore.OpenApi.Client.Kiota/JsonApiDotNetCore.OpenApi.Client.Kiota.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>net8.0</TargetFrameworks>
     <IsPackable>true</IsPackable>
@@ -10,7 +10,7 @@
   <Import Project="..\..\package-versions.props" />
 
   <PropertyGroup>
-    <VersionPrefix>$(JsonApiDotNetCoreVersionPrefix)</VersionPrefix>
+    <Version Condition="'$(OpenApiPreviewNumber)' != '' AND '$(VersionSuffix)' == ''">$(VersionPrefix)-preview.$(OpenApiPreviewNumber)</Version>
     <PackageTags>jsonapidotnetcore;jsonapi;json:api;dotnet;asp.net;rest;web-api;openapi;swagger;client;kiota</PackageTags>
     <Description>Provides OpenAPI support for JSON:API generated clients using Kiota.</Description>
     <Authors>json-api-dotnet</Authors>

src/JsonApiDotNetCore.OpenApi.Client.NSwag/JsonApiDotNetCore.OpenApi.Client.NSwag.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>net8.0</TargetFrameworks>
     <IsPackable>true</IsPackable>
@@ -9,7 +9,7 @@
   <Import Project="..\..\package-versions.props" />
 
   <PropertyGroup>
-    <VersionPrefix>$(JsonApiDotNetCoreVersionPrefix)</VersionPrefix>
+    <Version Condition="'$(OpenApiPreviewNumber)' != '' AND '$(VersionSuffix)' == ''">$(VersionPrefix)-preview.$(OpenApiPreviewNumber)</Version>
     <PackageTags>jsonapidotnetcore;jsonapi;json:api;dotnet;asp.net;rest;web-api;openapi;swagger;client;nswag</PackageTags>
     <Description>Provides OpenAPI support for JSON:API generated clients using NSwag.</Description>
     <Authors>json-api-dotnet</Authors>

src/JsonApiDotNetCore.OpenApi.Swashbuckle/JsonApiDotNetCore.OpenApi.Swashbuckle.csproj

@@ -9,7 +9,7 @@
   <Import Project="..\..\package-versions.props" />
 
   <PropertyGroup>
-    <VersionPrefix>$(JsonApiDotNetCoreVersionPrefix)</VersionPrefix>
+    <Version Condition="'$(OpenApiPreviewNumber)' != '' AND '$(VersionSuffix)' == ''">$(VersionPrefix)-preview.$(OpenApiPreviewNumber)</Version>
     <PackageTags>jsonapidotnetcore;jsonapi;json:api;dotnet;asp.net;rest;web-api;openapi;swagger;swaggerui;swashbuckle</PackageTags>
     <Description>A Swashbuckle integration that enables you to describe a JsonApiDotNetCore API with an OpenAPI specification.</Description>
     <Authors>json-api-dotnet</Authors>

src/JsonApiDotNetCore.SourceGenerators/JsonApiDotNetCore.SourceGenerators.csproj

@@ -11,7 +11,6 @@
   <Import Project="..\..\package-versions.props" />
 
   <PropertyGroup>
-    <VersionPrefix>$(JsonApiDotNetCoreVersionPrefix)</VersionPrefix>
     <PackageTags>jsonapidotnetcore;jsonapi;json:api;dotnet;asp.net;rest;web-api</PackageTags>
     <Description>Source generators for JsonApiDotNetCore, a framework for building JSON:API compliant REST APIs using ASP.NET and Entity Framework Core.</Description>
     <Authors>json-api-dotnet</Authors>

src/JsonApiDotNetCore/JsonApiDotNetCore.csproj

@@ -8,7 +8,6 @@
   <Import Project="..\..\package-versions.props" />
 
   <PropertyGroup>
-    <VersionPrefix>$(JsonApiDotNetCoreVersionPrefix)</VersionPrefix>
     <PackageTags>jsonapidotnetcore;jsonapi;json:api;dotnet;asp.net;rest;web-api</PackageTags>
     <Description>A framework for building JSON:API compliant REST APIs using ASP.NET and Entity Framework Core. Includes support for Atomic Operations. The ultimate goal of this library is to eliminate as much boilerplate as possible by offering out-of-the-box features such as sorting, filtering and pagination. You just need to focus on defining the resources and implementing your custom business logic. This library has been designed around dependency injection making extensibility incredibly easy.</Description>
     <Authors>json-api-dotnet</Authors>