Setup binary compatibility validator#1124
Merged
LikeTheSalad merged 1 commit intoAug 6, 2025
Merged
Conversation
LikeTheSalad
reviewed
Aug 4, 2025
fractalwrench
force-pushed
the
fractalwrench/binary-compat-validation
branch
from
e2923fb to
6253d2a
Compare
LikeTheSalad
approved these changes
Aug 6, 2025
This was referenced Aug 7, 2025
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
2 participants
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.
Goal
This changeset adds Kotlin's binary compatibility validator which generates a dump of API signatures and checks whether the project source code matches the known dump, thus allowing any API changes to be detected. The project works on Java & Kotlin files that are publicly exposed.
./gradlew apiCheckruns the task,./gradlew apiDumpregenerates the API dump file. The check will automatically run with./gradlew checkso CI should catch any regressions/changes in the public API.I've added this to any module that applies the
otel.android-library-conventionsgradle script and have generated a dump file for the existing APIs.Closes #217