Add binary-compatibility-validator to Chucker #509
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
cortinico
added
the
infra
MiSikora
approved these changes
Nov 29, 2020
vbuberen
approved these changes
Nov 29, 2020
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.
📄 Context
To prevent problems like #466 in the future, I'm introducing https://github.com/Kotlin/binary-compatibility-validator to Chucker.
This will force any PR that touches the public API, to also include a change to the corresponding
.apifile. To recompute the.apifile, developers should just callgw apiDump.📝 Changes
binary-compatibility-validatorpluginapiCheckbefore mergingsampleand non public packages from the API surface.📎 Related PR
Follow-up from #466
🚫 Breaking
None
🛠️ How to test
Please take a look at the
.apifile and let me know if you agree on it.If the CI is green, we should be good to go.
⏱️ Next steps
n/a