Enforce public API stability with binary-compatibility-validator (#11)#21
Merged
Conversation
Apply Kotlin's binary-compatibility-validator at the root project so both :sharingan and :sharingan-noop get apiDump/apiCheck. Commit the golden public -API dumps (Android/JVM .api and iOS .klib.api) for each module and run apiCheck on every PR via a new macOS workflow (macOS so the iOS klib ABI targets build alongside the Android/JVM surface). The "swap sharingan-noop in release" safety story depends on the two artifacts keeping an identical, stable public API; nothing enforced that before. apiCheck now fails the build when the surface drifts from the committed dumps. The sample app is excluded (not a published library). Documented apiDump/apiCheck in AGENTS.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #11