microsoft-authentication-library-for-dotnet icon indicating copy to clipboard operation
microsoft-authentication-library-for-dotnet copied to clipboard

[Internal] Automate API Review tool to protect against breaking API changes

Open bgavrilMS opened this issue 5 years ago • 8 comments
trafficstars

ApiCompat is used for Wilson and SAL, and we should extend to MSAL.

Here is the task group that we are using for cloud builds. If you are using only NuGet packages to get contract assemblies, you can disregard parameters prefixed with “ado”.

bgavrilMS avatar Jun 10 '20 12:06 bgavrilMS

@bgavrilMS checking to see if we still need this task?

gladjohn avatar Dec 01 '22 20:12 gladjohn

Yeah, I think it would be nice to explore this tool again. Most likely we want to wait until we get rid of xamarin - these kind of tools don't work too well with ancient targets.

https://stackoverflow.com/questions/73257002/generate-text-file-of-public-api-of-net-library-for-versioning-and-compatibilit

bgavrilMS avatar Dec 02 '22 14:12 bgavrilMS

Ok will revisit this after we remove xamarin support

gladjohn avatar Dec 02 '22 15:12 gladjohn

Consider using this: https://learn.microsoft.com/en-us/dotnet/fundamentals/package-validation/baseline-version-validator

keegan-caruso avatar Nov 04 '23 16:11 keegan-caruso

This is great, thanks for pointing this out @keegan-caruso. We should add this to MSAL, at least .net and .net fwk versions.

bgavrilMS avatar Nov 06 '23 10:11 bgavrilMS

It should also help document the API diff between MSAL 4 and MSAL 5

bgavrilMS avatar Nov 06 '23 10:11 bgavrilMS

Not worth it, we are not introducing that many apis.

bgavrilMS avatar May 08 '24 15:05 bgavrilMS

Another possible analyzer tool: https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md

pmaytak avatar Jul 22 '24 22:07 pmaytak