Prevent API and ABI breaking changes before publishing SDKs

[Zaid-Ajaj]

Description

When we publish a new SDK, we should make sure that the new version doesn't break API and ABI (application binary interface) compatibility with older Pulumi SDKs or existing provider SDKs. This happened in #311 because we introduced an optional argument which was non-breaking in terms of public API but it wasn't binary compatible (broke provider SDKs built with older versions of Pulumi SDK)

Resolution

Before the publishing step, we should check the API and ABI compatibility of the latest published nuget package against the newly created nuget before we actually push to nuget. We could use one of the following tools to help with this:

• Microsoft.DotNet.ApiCompat.Tool
• G-Research/ApiSurface