-
Notifications
You must be signed in to change notification settings - Fork 503
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add binary compatibility validator #2131
Add binary compatibility validator #2131
Conversation
I am not 100% strict in this. For example, documentation change I never add. In this case, I would like it to be added to the changelog as it informs our API consumers that we took measures against unintended API changes. |
Yes, that seems like a fine plan. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tnx for implementing this!
7a45526
to
df247e9
Compare
df247e9
to
f146ae4
Compare
Closes #2111
Description
I wasn't sure if I should add a Changelog entry, since this does not affect consumers at all 👀
Binary compatibility validator will compare the commited public API surface with current one. Task
apiCheck
will run on everycheck
invocation.If the public API changes, the
apiCheck
task will fail and will require dumping a new one with./gradlew apiDump
.I'm proposing to verify binary compatibility of every project that is published (and can be consumed by third party clients)
Checklist
Before submitting the PR, please check following (checks which are not relevant may be ignored):
Closes #<xxx>
orFixes #<xxx>
(replace<xxx>
with issue number)CHANGELOG.md
is updatedDocumentation is updated. See difference between snapshot and release documentation