Integrate Kotlin binary compatibility validator. #1120
Merged
Conversation
This file contains 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
pengdev
changed the title
pengdev
commented
Feb 4, 2022
pengdev
force-pushed
the
peng-binary-compatibility-validator
branch
from
88660a2
to
da6cb5f
Compare
pengdev
force-pushed
the
peng-binary-compatibility-validator
branch
from
da6cb5f
to
8768819
Compare
|
A sample output comparing with v10.2.0 release: |
|
@pengdev several q:
|
pengdev
force-pushed
the
peng-binary-compatibility-validator
branch
from
8768819
to
ba13c41
Compare
sounds good to me, will add the workflow to the PR templates.
I just added the api files for v10.2.0 release tag, to get a sense on how the bot works. Just updated the api files to match the latest codebase. |
pengdev
changed the title
kiryldz
approved these changes
Feb 8, 2022
pengdev
force-pushed
the
peng-binary-compatibility-validator
branch
from
cb68bf9
to
cc56e60
Compare
Chaoba
reviewed
Feb 10, 2022
| @@ -23,6 +23,9 @@ workflows: | |||
| - verify-docs: | |||
| requires: | |||
| - verify-code | |||
| - verify-kotlin-binary-compatibility: | |||
| requires: | |||
| - verify-code | |||
| - verify-api: | |||
There was a problem hiding this comment.
Should we remove verify-api?
There was a problem hiding this comment.
I think verify-api is a good indicator on reporting major/breaking changes, the binary compatibility validator and metalava doesn't report breaking changes automatically.
alexander-kulikovskii
approved these changes
Feb 11, 2022
IMO naming is a bit confusing, both api / binary compatibility mean similar things and it's not clear how are these checks different. WDYT about renaming, for example might be :
|
So, it's manual step, right? Sadly =\ |
yes, it's a manual step, but I will try to make a simple MakeFile config to do the api file update. |
Sounds good to me, I will address it in follow-up PR when introducing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary of changes
This PR:
Here's the suggested Workflow:
When starting to validate your library public API, we recommend the following workflow:
Preparation phase (one-time action):
apiDump..apifiles to your VCS.checktask will validate public API along with test run and will failthe build if API differs.
Regular workflow
actions should be performed.
checktask on your CI will validate everything.adjustments in existing one,
checktask will start to fail.apiDumpshould be executed manually,the resulting diff in
.apifile should be verified: only signatures you expected to change should be changed..apidiff along with code changes.User impact (optional)
Pull request checklist:
@JvmOverloads,@file:JvmName, etc).mapbox-maps-androidchangelog:<changelog></changelog>.v10.[version]release branch fix / enhancement, merge it tomainfirstly and then port tov10.[version]release branch.Fixes: < Link to related issues that will be fixed by this pull request, if they exist >
PRs must be submitted under the terms of our Contributor License Agreement CLA.