Improve release automation (#3317)

- Move script to bump the version from inline PowerShell to its own script.
- Copy script from Polly to update Public API baselines.
- Fix incorrectly sorted baseline document.
- Remove obsolete Public API baselines for .NET 6.

Author: martincostello

.github/bump-version.ps1

@@ -0,0 +1,55 @@
+#! /usr/bin/env pwsh
+param(
+    [Parameter(Mandatory = $false)][string] $NextVersion
+)
+
+$ErrorActionPreference = "Stop"
+
+if ($NextVersion.StartsWith("v")) {
+    $NextVersion = $NextVersion.Substring(1)
+}
+
+$repo = Join-Path $PSScriptRoot ".."
+$properties = Join-Path $repo "Directory.Build.props"
+
+$xml = [xml](Get-Content $properties)
+$versionPrefix = $xml.SelectSingleNode('Project/PropertyGroup/VersionPrefix')
+$publishedVersion = $versionPrefix.InnerText
+
+if (-Not [string]::IsNullOrEmpty($NextVersion)) {
+  $version = [System.Version]::new($NextVersion)
+} else {
+  $version = [System.Version]::new($publishedVersion)
+  $version = [System.Version]::new($version.Major, $version.Minor, $version.Build + 1)
+}
+
+$updatedVersion = $version.ToString()
+$versionPrefix.InnerText = $updatedVersion
+
+$packageValidationBaselineVersion = $xml.SelectSingleNode('Project/PropertyGroup/PackageValidationBaselineVersion')
+$packageValidationBaselineVersion.InnerText = $publishedVersion
+
+Write-Output "Bumping version from $publishedVersion to $version"
+
+$settings = New-Object System.Xml.XmlWriterSettings
+$settings.Encoding = New-Object System.Text.UTF8Encoding($false)
+$settings.Indent = $true
+$settings.OmitXmlDeclaration = $true
+
+try {
+    $writer = [System.Xml.XmlWriter]::Create($properties, $settings)
+    $xml.Save($writer)
+} finally {
+    if ($writer) {
+        $writer.Flush()
+        $writer.Dispose()
+        "" >> $properties
+    }
+    $writer = $null
+}
+
+$githubOutput = $env:GITHUB_OUTPUT
+
+if (($null -ne $githubOutput) -and (Test-Path $githubOutput)) {
+  "version=${updatedVersion}" >> $githubOutput
+}

.github/update-baselines.ps1

@@ -0,0 +1,62 @@
+#! /usr/bin/env pwsh
+param()
+
+$ErrorActionPreference = "Stop"
+
+$encoding = New-Object System.Text.UTF8Encoding($true)
+$releasedName = "PublicAPI.Shipped.txt"
+$unshippedName = "PublicAPI.Unshipped.txt"
+
+$repo = Join-Path $PSScriptRoot ".."
+$src = Join-Path $repo "src"
+$files = Get-ChildItem -Path $src -Filter $unshippedName -Recurse
+
+# See https://github.com/dotnet/roslyn-analyzers/blob/b07c100bfc66013a8444172d00cfa04c9ceb5a97/src/PublicApiAnalyzers/Core/CodeFixes/DeclarePublicApiFix.cs#L373-L390
+$comparer = {
+    param(
+        [string]$x,
+        [string]$y
+    )
+    $comparison = [System.StringComparer]::OrdinalIgnoreCase.Compare($x, $y)
+    if ($comparison -eq 0) {
+        $comparison = [System.StringComparer]::Ordinal.Compare($x, $y)
+    }
+    return $comparison;
+}
+
+foreach ($file in $files) {
+    $directory = [System.IO.Path]::GetDirectoryName($file)
+    $changesPath = Join-Path $directory $unshippedName
+    $baselinePath = Join-Path $directory $releasedName
+
+    $baseline = Get-Content $baselinePath
+    $baseline = [System.Collections.Generic.List[string]]$baseline
+
+    $additions = Get-Content $changesPath
+    $additions = [System.Collections.Generic.List[string]]$additions
+
+    $edited = $false
+
+    # Skip any "#nullable enable" header
+    $nullableHeader = "#nullable enable"
+    $index = (($additions.Count -gt 0) -And ($additions[0] -eq $nullableHeader)) ? 1 : 0
+    while ($additions.Count -gt $index) {
+        $addition = $additions[$index]
+        $additions.RemoveAt($index)
+        $baseline.Add($addition)
+        $edited = $true
+    }
+
+    if ($edited) {
+        $additions.Sort($comparer)
+        $baseline.Sort($comparer)
+
+        if (($additions.Count -eq 1) -and ($additions[0] -eq $nullableHeader)) {
+          $additions | Set-Content $changesPath -Encoding $encoding
+        } else {
+          $null | Set-Content $changesPath -Encoding $encoding
+        }
+
+        $baseline | Set-Content $baselinePath -Encoding $encoding
+    }
+}

.github/workflows/bump-version.yml

@@ -35,42 +35,11 @@ jobs:
         shell: pwsh
         env:
           NEXT_VERSION: ${{ inputs.version }}
-        run: |
-          $properties = Join-Path "." "Directory.Build.props"
-
-          $xml = [xml](Get-Content $properties)
-          $versionPrefix = $xml.SelectSingleNode('Project/PropertyGroup/VersionPrefix')
-          $publishedVersion = $versionPrefix.InnerText;
-
-          if (-Not [string]::IsNullOrEmpty(${env:NEXT_VERSION})) {
-            $version = [System.Version]::new(${env:NEXT_VERSION})
-          } else {
-            $version = [System.Version]::new($publishedVersion)
-            $version = [System.Version]::new($version.Major, $version.Minor, $version.Build + 1)
-          }
-
-          $updatedVersion = $version.ToString()
-          $versionPrefix.InnerText = $updatedVersion
-
-          $packageValidationBaselineVersion = $xml.SelectSingleNode('Project/PropertyGroup/PackageValidationBaselineVersion')
-          $packageValidationBaselineVersion.InnerText = $publishedVersion
+        run: ./.github/bump-version.ps1 ${env:NEXT_VERSION}
 
-          $settings = New-Object System.Xml.XmlWriterSettings
-          $settings.Encoding = New-Object System.Text.UTF8Encoding($false)
-          $settings.Indent = $true
-          $settings.OmitXmlDeclaration = $true
-
-          $writer = [System.Xml.XmlWriter]::Create($properties, $settings)
-
-          $xml.Save($writer)
-
-          $writer.Flush()
-          $writer.Close()
-          $writer = $null
-
-          "" >> $properties
-
-          "version=${updatedVersion}" >> $env:GITHUB_OUTPUT
+      - name: Update public API baselines
+        shell: pwsh
+        run: ./.github/update-baselines.ps1
 
       - name: Push changes to GitHub
         id: push-changes

Swashbuckle.AspNetCore.sln

@@ -95,15 +95,19 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".github", ".github", "{3BA087DA-788C-43D6-9D8B-1EF017014A4A}"
 	ProjectSection(SolutionItems) = preProject
 		.github\actionlint-matcher.json = .github\actionlint-matcher.json
+		.github\bump-version.ps1 = .github\bump-version.ps1
 		.github\dependabot.yml = .github\dependabot.yml
+		.github\update-baselines.ps1 = .github\update-baselines.ps1
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{A0EC16BE-C520-4FCF-BB54-2D79CD255F00}"
 	ProjectSection(SolutionItems) = preProject
 		.github\workflows\actions-lint.yml = .github\workflows\actions-lint.yml
 		.github\workflows\build.yml = .github\workflows\build.yml
+		.github\workflows\bump-version.yml = .github\workflows\bump-version.yml
 		.github\workflows\codeql-analysis.yml = .github\workflows\codeql-analysis.yml
 		.github\workflows\ossf-scorecard.yml = .github\workflows\ossf-scorecard.yml
+		.github\workflows\release.yml = .github\workflows\release.yml
 		.github\workflows\stale.yml = .github\workflows\stale.yml
 		.github\workflows\update-dotnet-sdk.yml = .github\workflows\update-dotnet-sdk.yml
 	EndProjectSection

src/Swashbuckle.AspNetCore.Annotations/PublicAPI/net6.0/PublicAPI.Shipped.txt

@@ -7,12 +7,12 @@ static Microsoft.Extensions.DependencyInjection.SwaggerOptionsExtensions.SetCust
 static Microsoft.Extensions.DependencyInjection.SwaggerServiceCollectionExtensions.ConfigureSwagger(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action<Swashbuckle.AspNetCore.Swagger.SwaggerOptions> setupAction) -> void
 Swashbuckle.AspNetCore.Swagger.IAsyncSwaggerProvider
 Swashbuckle.AspNetCore.Swagger.IAsyncSwaggerProvider.GetSwaggerAsync(string documentName, string host = null, string basePath = null) -> System.Threading.Tasks.Task<Microsoft.OpenApi.Models.OpenApiDocument>
+Swashbuckle.AspNetCore.Swagger.ISwaggerDocumentMetadataProvider
+Swashbuckle.AspNetCore.Swagger.ISwaggerDocumentMetadataProvider.GetDocumentNames() -> System.Collections.Generic.IList<string>
 Swashbuckle.AspNetCore.Swagger.ISwaggerDocumentSerializer
 Swashbuckle.AspNetCore.Swagger.ISwaggerDocumentSerializer.SerializeDocument(Microsoft.OpenApi.Models.OpenApiDocument document, Microsoft.OpenApi.Writers.IOpenApiWriter writer, Microsoft.OpenApi.OpenApiSpecVersion specVersion) -> void
 Swashbuckle.AspNetCore.Swagger.ISwaggerProvider
 Swashbuckle.AspNetCore.Swagger.ISwaggerProvider.GetSwagger(string documentName, string host = null, string basePath = null) -> Microsoft.OpenApi.Models.OpenApiDocument
-Swashbuckle.AspNetCore.Swagger.ISwaggerDocumentMetadataProvider
-Swashbuckle.AspNetCore.Swagger.ISwaggerDocumentMetadataProvider.GetDocumentNames() -> System.Collections.Generic.IList<string>
 Swashbuckle.AspNetCore.Swagger.SwaggerEndpointOptions
 Swashbuckle.AspNetCore.Swagger.SwaggerEndpointOptions.PreSerializeFilters.get -> System.Collections.Generic.List<System.Action<Microsoft.OpenApi.Models.OpenApiDocument, Microsoft.AspNetCore.Http.HttpRequest>>
 Swashbuckle.AspNetCore.Swagger.SwaggerEndpointOptions.SwaggerEndpointOptions() -> void