build(revapi): Verify API/ABI compatibility during build #246
Conversation
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
markjschreiber
approved these changes
Oct 31, 2023
Contributor
markjschreiber
left a comment
markjschreiber
left a comment
There was a problem hiding this comment.
Thanks for the update
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.
Description of changes:
As mentioned in #223 (comment):
This PR adds the revapi gradle plugin so that API/ABI compatibility is checked during the build (more specifically during
./gradlew check). Whenever changes are introduced, the plugin verifies against the latest version (currently 1.2.4) and fails the build in case the are API/ABI incompatibilities. Breaking changes can be accepted as documented in the Contribution guide.Since there are many breaking changes for v2, they are currently accepted in the CI build. Once v2 is released, it the check on CI build should be commented in order to guarantee a stable API/ABI.
Here is a list of breaking changes since 1.2.4: revapi.yml
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.