Skip to content

ApiCompat Diffs

Max Katz edited this page Nov 30, 2023 · 5 revisions

https://github.com/AvaloniaUI/Avalonia/pull/4348 introduced API Compatibility checks. https://github.com/AvaloniaUI/Avalonia/pull/12072 introduced second version of API Compatibility checks.

This means if binary api compatibility is broken it will be a build error during Nuke build.

By default, local build with nuke will update API definitions files that need to be committed with your changes. On CI build, though, if there is any API compatibility problem, nuke will fail with an error. It is expected behavior for PR builds.

If you need to run nuke build locally, but don't want to update API definitions, run with nuke --update-api-suppression false parameter. You also can redefine API baseline version with api-baseline parameter. By default, current major version is a baseline. For example, for 11.0.5 build current major would be 11.0.0.