Following up on API baseline check and documentation

.azure/pipelines/ci.yml

@@ -128,6 +128,9 @@ stages:
         steps:
         - powershell: ./eng/scripts/CodeCheck.ps1 -ci $(_InternalRuntimeDownloadArgs)
           displayName: Run eng/scripts/CodeCheck.ps1
+          env:
+            PULLREQUEST_SOURCEBRANCH: $(System.PullRequest.SourceBranch)
+            PULLREQUEST_TARGETBRANCH: $(System.PullRequest.TargetBranch)
         artifacts:
         - name: Code_Check_Logs
           path: artifacts/log/

docs/APIBaselines.md

@@ -6,8 +6,24 @@ This document contains information regarding API baseline files and how to work
 
 When creating a new implementation (i.e. src) project, it's necessary to manually add API baseline files since API baseline are enabled by default. If the project is a non-shipping or test only project, add `<AddPublicApiAnalyzers>false</AddPublicApiAnalyzers>` to the project to disable these checks. To add baseline files to the project:
 
-1. Copy eng\PublicAPI.empty.txt to the project directory and rename it to PublicAPI.Shipped.txt
-1. Copy eng\PublicAPI.empty.txt to the project directory and rename it to PublicAPI.Unshipped.txt
+1. `cp .\eng\PublicAPI.empty.txt {new folder}\PublicAPI.Shipped.txt`
+1. `cp .\eng\PublicAPI.empty.txt {new folder}\PublicAPI.Unshipped.txt`
+1. Update AspNetCore.sln and relevant `*.slnf` file to include the new project
+1. `{directory containing relevant *.slnf}\startvs.cmd`
+1. F6 # or whatever your favourite build gesture is
+1. Click on a RS0016 (or whatever) error
+1. Right click in editor on underscored symbol or go straight to the “quick fix” icon to its left. Control-. also works.
+1. Choose “Add Blah to public API” / “Fix all occurrences in … Solution”
+1. Click Apply
+1. F6 # again to see if the fixer missed anything or if other RS00xx errors show up (not uncommon)
+1. Suppress or fix other problems as needed but please suppress (if suppressing) using attributes and not globally or with `#pragma`s because attributes make the justification obvious e.g. for common errors that can't be fixed
+    `[SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]`
+    or
+    `[SuppressMessage("ApiDesign", "RS0027:Public API with optional parameter(s) should have the most parameters amongst its public overloads.", Justification = "Required to maintain compatibility")]`
+
+More information available in
+-	https://github.com/dotnet/roslyn-analyzers/blob/master/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md
+-	https://github.com/dotnet/roslyn-analyzers/blob/master/src/PublicApiAnalyzers/Microsoft.CodeAnalysis.PublicApiAnalyzers.md
 
 ## PublicAPI.Shipped.txt
 
@@ -47,4 +63,4 @@ Microsoft.AspNetCore.DataProtection.Infrastructure.IApplicationDiscriminator.Dis
 
 ## Updating baselines after major releases
 
-TODO
+This will be performed by the build team using scripts at https://github.com/dotnet/roslyn/tree/master/scripts/PublicApi. The process moves the content of PublicAPI.Unshipped.txt into PublicAPI.Shipped.txt

eng/scripts/CodeCheck.ps1

@@ -191,15 +191,18 @@ try {
         }
     }
 
-    Write-Host "Checking for changes to API baseline files"
+    $targetBranch = $env:PULLREQUEST_TARGETBRANCH
+    $sourceBranch = $env:PULLREQUEST_SOURCEBRANCH
 
     # Retrieve the set of changed files compared to main
-    $commitSha = git rev-parse HEAD
-    $changedFilesFromMain = git --no-pager diff origin/main...$commitSha --ignore-space-change --name-only --diff-filter=ar
+    Write-Host "Checking for changes to API baseline files $targetBranch...$sourceBranch"
+
+    $changedFilesFromMain = git --no-pager diff $targetBranch...$sourceBranch --ignore-space-change --name-only --diff-filter=ar
     $changedAPIBaselines = [System.Collections.Generic.List[string]]::new()
 
     if ($changedFilesFromMain) {
         foreach ($file in $changedFilesFromMain) {
+            # Check for changes in Shipped in dev branches and both Shipped and Unshipped in servicing branches
             if ($file -like '*PublicAPI.Shipped.txt') {
                 $changedAPIBaselines.Add($file)
             }

src/Caching/SqlServer/src/PublicAPI.Shipped.txt

@@ -25,3 +25,5 @@ Microsoft.Extensions.DependencyInjection.SqlServerCachingServicesExtensions
 ~Microsoft.Extensions.Caching.SqlServer.SqlServerCacheOptions.TableName.get -> string
 ~Microsoft.Extensions.Caching.SqlServer.SqlServerCacheOptions.TableName.set -> void
 ~static Microsoft.Extensions.DependencyInjection.SqlServerCachingServicesExtensions.AddDistributedSqlServerCache(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action<Microsoft.Extensions.Caching.SqlServer.SqlServerCacheOptions> setupAction) -> Microsoft.Extensions.DependencyInjection.IServiceCollection
+
+TEST