[repo] Automate PackageValidationBaselineVersion update after stable releases (open-telemetry#1803)

CodeBlanch · web-flow · commit 2147e02a5461 · 2024-05-15T12:15:17.000-07:00
diff --git a/.github/workflows/Component.Package.yml b/.github/workflows/Component.Package.yml
@@ -6,15 +6,12 @@ on:
       project-name:
         required: true
         type: string
-      release-name:
-        required: false
-        type: string
-        default: ''
 
 jobs:
   build-test-pack:
     permissions:
       contents: write
+      pull-requests: write
 
     runs-on: windows-latest
 
@@ -60,3 +57,15 @@ jobs:
           -tag '${{ github.ref_name }}'
       env:
         GH_TOKEN: ${{ github.token }}
+
+    - name: Create GitHub Pull Request to update PackageValidationBaselineVersion in projects
+      if: |
+        !contains(github.ref_name, '-alpha') && !contains(github.ref_name, '-beta') && !contains(github.ref_name, '-rc')
+      shell: pwsh
+      run: |
+        Import-Module .\build\scripts\post-release.psm1
+
+        CreatePackageValidationBaselineVersionUpdatePullRequest `
+          -tag '${{ github.ref_name }}'
+      env:
+        GH_TOKEN: ${{ github.token }}
diff --git a/.github/workflows/package-Exporter.Geneva.yml b/.github/workflows/package-Exporter.Geneva.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Exporter.Geneva
diff --git a/.github/workflows/package-Exporter.OneCollector.yml b/.github/workflows/package-Exporter.OneCollector.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Exporter.OneCollector
diff --git a/.github/workflows/package-Extensions.yml b/.github/workflows/package-Extensions.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Extensions
diff --git a/.github/workflows/package-Instrumentation.AspNet.yml b/.github/workflows/package-Instrumentation.AspNet.yml
@@ -15,10 +15,7 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Instrumentation.AspNet
-      release-name: 'OpenTelemetry Asp.Net Instrumentation Packages'
     secrets: inherit
diff --git a/.github/workflows/package-Instrumentation.AspNetCore.yml b/.github/workflows/package-Instrumentation.AspNetCore.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Instrumentation.AspNetCore
diff --git a/.github/workflows/package-Instrumentation.EventCounters.yml b/.github/workflows/package-Instrumentation.EventCounters.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Instrumentation.EventCounters
diff --git a/.github/workflows/package-Instrumentation.GrpcNetClient.yml b/.github/workflows/package-Instrumentation.GrpcNetClient.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Instrumentation.GrpcNetClient
diff --git a/.github/workflows/package-Instrumentation.Http.yml b/.github/workflows/package-Instrumentation.Http.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Instrumentation.Http
diff --git a/.github/workflows/package-Instrumentation.Owin.yml b/.github/workflows/package-Instrumentation.Owin.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Instrumentation.Owin
diff --git a/.github/workflows/package-Instrumentation.Process.yml b/.github/workflows/package-Instrumentation.Process.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Instrumentation.Process
diff --git a/.github/workflows/package-Instrumentation.Runtime.yml b/.github/workflows/package-Instrumentation.Runtime.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Instrumentation.Runtime
diff --git a/.github/workflows/package-Instrumentation.SqlClient.yml b/.github/workflows/package-Instrumentation.SqlClient.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Instrumentation.SqlClient
diff --git a/.github/workflows/package-Instrumentation.StackExchangeRedis.yml b/.github/workflows/package-Instrumentation.StackExchangeRedis.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Instrumentation.StackExchangeRedis
diff --git a/.github/workflows/package-Instrumentation.Wcf.yml b/.github/workflows/package-Instrumentation.Wcf.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Instrumentation.Wcf
diff --git a/.github/workflows/package-PersistentStorage.yml b/.github/workflows/package-PersistentStorage.yml
@@ -15,10 +15,7 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.PersistentStorage
-      release-name: 'OpenTelemetry Persistent Storage Packages'
     secrets: inherit
diff --git a/.github/workflows/package-ResourceDetectors.Azure.yml b/.github/workflows/package-ResourceDetectors.Azure.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.ResourceDetectors.Azure
diff --git a/.github/workflows/package-ResourceDetectors.Host.yml b/.github/workflows/package-ResourceDetectors.Host.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.ResourceDetectors.Host
diff --git a/.github/workflows/package-ResourceDetectors.ProcessRuntime.yml b/.github/workflows/package-ResourceDetectors.ProcessRuntime.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.ResourceDetectors.ProcessRuntime
diff --git a/.github/workflows/package-Resources.Gcp.yml b/.github/workflows/package-Resources.Gcp.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Resources.Gcp
diff --git a/.github/workflows/package-Resources.Process.yml b/.github/workflows/package-Resources.Process.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.Resources.Process
diff --git a/.github/workflows/package-SemanticConventions.yml b/.github/workflows/package-SemanticConventions.yml
@@ -13,8 +13,6 @@ on:
 
 jobs:
   call-build-test-pack:
-    permissions:
-      contents: write
     uses: ./.github/workflows/Component.Package.yml
     with:
       project-name: OpenTelemetry.SemanticConventions
diff --git a/build/scripts/post-release.psm1 b/build/scripts/post-release.psm1
@@ -93,3 +93,109 @@ $content
 
 Export-ModuleMember -Function CreateRelease
 
+function CreatePackageValidationBaselineVersionUpdatePullRequest {
+  param(
+    [Parameter(Mandatory=$true)][string]$tag,
+    [Parameter()][string]$gitUserName=$gitHubBotUserName,
+    [Parameter()][string]$gitUserEmail=$gitHubBotEmail,
+    [Parameter()][string]$targetBranch="main"
+  )
+
+  $match = [regex]::Match($tag, '^(.*?-)(.*)$')
+  if ($match.Success -eq $false)
+  {
+      throw 'Could not parse prefix from tag'
+  }
+
+  $tagPrefix = $match.Groups[1].Value
+  $version = $match.Groups[2].Value
+
+  $branch="release/post-stable-${tag}-update"
+
+  git config user.name $gitUserName
+  git config user.email $gitUserEmail
+
+  git switch --create $branch origin/$targetBranch --no-track 2>&1 | % ToString
+  if ($LASTEXITCODE -gt 0)
+  {
+      throw 'git switch failure'
+  }
+
+  $versionTagRegex = "<PackageValidationBaselineVersion>.*</PackageValidationBaselineVersion>"
+
+  $projects = Get-ChildItem -Path src/**/*.csproj |
+    where { $_ | Select-String "<MinVerTagPrefix>$tagPrefix</MinVerTagPrefix>" } |
+    where { $_ | Select-String $versionTagRegex }
+
+  if ($projects.Length -ne 0)
+  {
+    foreach ($project in $projects) {
+      (Get-Content $project) `
+          -replace $versionTagRegex, "<PackageValidationBaselineVersion>$version</PackageValidationBaselineVersion>" |
+        Set-Content $project
+
+      git add $project 2>&1 | % ToString
+      if ($LASTEXITCODE -gt 0)
+      {
+          throw 'git add failure'
+      }
+    }
+  }
+
+  $diabledTag = "<DisablePackageBaselineValidation>true</DisablePackageBaselineValidation>"
+
+  $disabledProjects = Get-ChildItem -Path src/**/*.csproj |
+    where { $_ | Select-String "<MinVerTagPrefix>$tagPrefix</MinVerTagPrefix>" } |
+    where { $_ | Select-String $diabledTag }
+
+  if ($disabledProjects.Length -ne 0)
+  {
+    foreach ($project in $disabledProjects) {
+      $content = (Get-Content $project -Raw)
+
+      $content = $content -replace $diabledTag, "<PackageValidationBaselineVersion>$version</PackageValidationBaselineVersion>"
+
+      $content = $content -replace "<!--\s*?Do not run Package Baseline Validation[\S\s]*?-->\s*", ""
+
+      Set-Content $project -Value $content.TrimEnd()
+
+      git add $project 2>&1 | % ToString
+      if ($LASTEXITCODE -gt 0)
+      {
+          throw 'git add failure'
+      }
+    }
+  }
+
+  git commit -m "Update PackageValidationBaselineVersion in $tagPrefix projects to $version." 2>&1 | % ToString
+  if ($LASTEXITCODE -gt 0)
+  {
+      throw 'git commit failure'
+  }
+
+  git push -u origin $branch 2>&1 | % ToString
+  if ($LASTEXITCODE -gt 0)
+  {
+      throw 'git push failure'
+  }
+
+  $body =
+@"
+Note: This PR was opened automatically by the [package workflow](https://github.com/$gitRepository/actions/workflows/Component.Package.yml).
+
+Merge once packages are available on NuGet and the build passes.
+
+## Changes
+
+* Sets ``PackageValidationBaselineVersion`` in ``$tagPrefix`` projects to ``$version``.
+"@
+
+  gh pr create `
+    --title "[repo] $tagPrefix stable release $version updates" `
+    --body $body `
+    --base $targetBranch `
+    --head $branch `
+    --label infra
+}
+
+Export-ModuleMember -Function CreatePackageValidationBaselineVersionUpdatePullRequest
diff --git a/opentelemetry-dotnet-contrib.sln b/opentelemetry-dotnet-contrib.sln
@@ -57,7 +57,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{
 		.github\workflows\package-Instrumentation.GrpcNetClient.yml = .github\workflows\package-Instrumentation.GrpcNetClient.yml
 		.github\workflows\package-Instrumentation.Hangfire.yml = .github\workflows\package-Instrumentation.Hangfire.yml
 		.github\workflows\package-Instrumentation.Http.yml = .github\workflows\package-Instrumentation.Http.yml
-		.github\workflows\package-Instrumentation.MassTransit.yml = .github\workflows\package-Instrumentation.MassTransit.yml
 		.github\workflows\package-Instrumentation.Owin.yml = .github\workflows\package-Instrumentation.Owin.yml
 		.github\workflows\package-Instrumentation.Process.yml = .github\workflows\package-Instrumentation.Process.yml
 		.github\workflows\package-Instrumentation.Quartz.yml = .github\workflows\package-Instrumentation.Quartz.yml
@@ -71,6 +70,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{
 		.github\workflows\package-ResourceDetectors.Container.yml = .github\workflows\package-ResourceDetectors.Container.yml
 		.github\workflows\package-ResourceDetectors.Host.yml = .github\workflows\package-ResourceDetectors.Host.yml
 		.github\workflows\package-ResourceDetectors.ProcessRuntime.yml = .github\workflows\package-ResourceDetectors.ProcessRuntime.yml
+		.github\workflows\package-Resources.Gcp.yml = .github\workflows\package-Resources.Gcp.yml
 		.github\workflows\package-Resources.Process.yml = .github\workflows\package-Resources.Process.yml
 		.github\workflows\package-Sampler.AWS.yml = .github\workflows\package-Sampler.AWS.yml
 		.github\workflows\package-SemanticConventions.yml = .github\workflows\package-SemanticConventions.yml
@@ -335,9 +335,9 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Projects", "Projects", "{04
 		build\Projects\OpenTelemetry.PersistentStorage.proj = build\Projects\OpenTelemetry.PersistentStorage.proj
 		build\Projects\OpenTelemetry.ResourceDetectors.Azure.proj = build\Projects\OpenTelemetry.ResourceDetectors.Azure.proj
 		build\Projects\OpenTelemetry.ResourceDetectors.Host.proj = build\Projects\OpenTelemetry.ResourceDetectors.Host.proj
+		build\Projects\OpenTelemetry.ResourceDetectors.Process.proj = build\Projects\OpenTelemetry.ResourceDetectors.Process.proj
 		build\Projects\OpenTelemetry.ResourceDetectors.ProcessRuntime.proj = build\Projects\OpenTelemetry.ResourceDetectors.ProcessRuntime.proj
 		build\Projects\OpenTelemetry.Resources.Gcp.proj = build\Projects\OpenTelemetry.Resources.Gcp.proj
-		build\Projects\OpenTelemetry.Resources.Process.proj = build\Projects\OpenTelemetry.Resources.Process.proj
 		build\Projects\OpenTelemetry.SemanticConventions.proj = build\Projects\OpenTelemetry.SemanticConventions.proj
 	EndProjectSection
 EndProject
@@ -893,8 +893,6 @@ Global
 		{048509D6-FB49-4B84-832A-90E55520B97B} = {824BD1DE-3FA8-4FE0-823A-FD365EAC78AF}
 		{95372E82-CA5B-4C61-BD6C-74E6AB1970D4} = {22DF5DC0-1290-4E83-A9D8-6BB7DE3B3E63}
 		{B6157646-8EBA-464C-99B9-C386D474CB12} = {2097345F-4DD3-477D-BC54-A922F9B2B402}
-		{A5FCDD8F-20FF-4657-804E-707EAD4FE31D} = {22DF5DC0-1290-4E83-A9D8-6BB7DE3B3E63}
-		{A5EF701C-439E-407F-8BB4-394166000C6D} = {2097345F-4DD3-477D-BC54-A922F9B2B402}
 		{033CA8D4-1529-413A-B244-07958D5F9A48} = {22DF5DC0-1290-4E83-A9D8-6BB7DE3B3E63}
 		{36271347-2055-438E-9659-B71542A17A73} = {2097345F-4DD3-477D-BC54-A922F9B2B402}
 		{7AD707F9-DC6D-430A-8834-D5DCD517BF6E} = {2097345F-4DD3-477D-BC54-A922F9B2B402}
