search

AzureAD / microsoft-authentication-library-for-dotnet

Microsoft Authentication Library (MSAL) for .NET
https://aka.ms/msal-net
MIT License
1.37k stars 337 forks source link

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

Open bgavrilMS opened 4 years ago

bgavrilMS commented 4 years ago

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”.

gladjohn commented 1 year ago

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

bgavrilMS commented 1 year ago

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

gladjohn commented 1 year ago

Ok will revisit this after we remove xamarin support

keegan-caruso commented 10 months ago

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

bgavrilMS commented 10 months ago

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

bgavrilMS commented 10 months ago

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

bgavrilMS commented 4 months ago

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

pmaytak commented 1 month ago

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