Add public API baselines for rest of our implementation projects

[dougbu]

If joining me in this endeavour, please assign yourself and add your name in parentheses on the line or lines below. Would rather not have multiple people working on adding the same files in parallel 😺

• src/Analyzers (@Pilchie) - contains no projects that need PublicApi.*.txt files files exist, but aren't used by the build yet.
• src/Antiforgery (@Pilchie)
• src/Azure (@Pilchie) - needs a fix to the analyzer for Razor generator (Analyzers should be invoked only in a single phase when compiling Razor projects roslyn#47350)
• src/Components (@dougbu)
• src/Configuration.KeyPerFile (@Pilchie)
• src/DataProtection (@Pilchie)
• src/DefaultBuilder (@Pilchie)
• src/Features (@Pilchie)
• src/FileProviders (@Pilchie)
• src/Framework - contains no projects that need PublicApi.*.txt files (@Pilchie)
• src/Grpc (@Pilchie)
• src/HealthChecks (@Pilchie)
• src/Hosting (@Pilchie)
• src/Html (@dougbu)
• src/Http (@dougbu)
• src/Identity (@Pilchie) - needs a fix to the analyzer for Razor generator (Analyzers should be invoked only in a single phase when compiling Razor projects roslyn#47350)
• src/Installers - contains no projects that need PublicApi.*.txt files
• src/JSInterop (@Pilchie)
• src/Localization (@Pilchie)
• src/Logging.AzureAppServices (@Pilchie)
• src/Middleware (@Pilchie)
• src/ObjectPool (@Pilchie)
• src/Razor (@Pilchie)
• src/Security (@Pilchie)
• src/Servers (@Pilchie)
• src/SignalR (@Pilchie)
• src/Testing (@Pilchie)
• src/SiteExtensions (@Pilchie)
• src/WebEncoders (@Pilchie)

I left MusicStore, ProjectTemplates, Shared, and Tools out because I'm pretty sure they don't contain $(IsImplementationProject) C# projects. If I'm wrong, please add to the list.

Mvc is already done.

[wtgodbe]

Seems like maybe the kind of thing I could do on ops duty? (Tuesday & Wednesday this week)

[dougbu]

The PublicApi.*.txt files aren’t really intended for manual intervention. To add them copy almost-empty files like src\Mvc\Mvc.Abstractions\src\PublicAPI.Shipped.txt into the directories you're adding baselines to e.g.

1. cp .\src\Mvc\Mvc.Abstractions\src\PublicAPI.Shipped.txt .\src\Http\Http.Abstractions\src\PublicAPI.Shipped.txt
2. cp .\src\Mvc\Mvc.Abstractions\src\PublicAPI.Shipped.txt .\src\Http\Http.Abstractions\src\PublicAPI.Unshipped.txt
3. . .\activate.ps1
4. .\src\Http\startvs.cmd
5. F6 # or whatever your favourite build gesture is
6. Click on a RS0016 error
7. Right click in editor on underscored symbol or go straight to the “quick fix” icon to its left
   . Control-. also works.
8. Choose “Add Blah to public API” / “Fix all occurrences in … Solution”
9. Click Apply
10. F6 # yes, again to see if the fixer missed anything or if other RS00xx errors show up (not uncommon)
11. Suppress or fix other problems as needed but please suppress (if suppressing) using attributes and not globally or with #pragmas because attributes make the justification obvious
    • The fixer tends to crash VS or at least the current Int Preview version. Search for other attributes suppressing the error and copy it where you need it e.g. I suppressed RS0026 at

      aspnetcore/src/Mvc/Mvc.Core/src/Routing/ControllerLinkGeneratorExtensions.cs

      Line 40 in 918d953

      [SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]

      • Add using System.Diagnostics.CodeAnalysis; if it's not already there.
    • Or, if the API is something new in 5.0, fix the problem as described in https://github.com/dotnet/roslyn/blob/master/docs/Adding%20Optional%20Parameters%20in%20Public%20API.md and related docs.
    • Reach out to me if you're not sure what action to take.

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

[dougbu]

@wtgodbe if you don't see anything to improve in the project templates tests and you have time, sure take something here. But, it's pretty much the last ops-on-call priority from my perspective.

[Pilchie]

Working on a few of these today.

[dougbu]

Thanks @Pilchie❕

[dougbu]

One note I forgot: src\Mvc\Mvc.Abstractions\src\PublicAPI.Shipped.txt contains the single line

#nullable enable

This may be incorrect in projects where #5680 hasn't been done. I'm not positive about this but recommend seeing if correct files are generated in such a project and, if necessary, starting with a completely empty file instead (where appropriate). Please let us know the results here😺