Skip to content

Add binary compatibility validation in KGP for Kotlin 2.2.0 #4886

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

Merged
merged 1 commit into from
Jun 16, 2025

Conversation

sarahhaggarty
Copy link
Collaborator

This PR adds information about how to use binary compatibility validation in the KGP for Kotlin 2.2.0.

@sarahhaggarty sarahhaggarty requested a review from a team as a code owner June 10, 2025 10:23
@sarahhaggarty sarahhaggarty requested a review from shanshin June 10, 2025 11:50
@sarahhaggarty sarahhaggarty force-pushed the abi-validation branch 3 times, most recently from cd5f8a8 to f98ef77 Compare June 11, 2025 15:49
@3flex
Copy link
Contributor

3flex commented Jun 12, 2025

Are there any migration tips for those moving from https://github.com/Kotlin/binary-compatibility-validator?

Is this a drop-in replacement if moving from BCV 0.17.0 to KGP 2.2.0? Does this new feature use the same output format and location?

@shanshin
Copy link

Are there any migration tips for those moving from https://github.com/Kotlin/binary-compatibility-validator?

Since Gradle DSL for BCV in KGP is experimental in the first approximation, we do not give instructions so that existing production projects do not migrate to it. DSL will be changed in the next version.

Is this a drop-in replacement if moving from BCV 0.17.0 to KGP 2.2.0?

There is no need to replace it now, the experimental DSL is suitable for pet projects to try out the approach and collect initial feedback.
BCV 0.17.0 still works and it can be used along with KGP 2.2.0.

Does this new feature use the same output format and location?

The format and location match, we are trying to implement a smooth migration from a separate plug-in to the KGP, but so far not all the original features have been migrated.

Copy link
Contributor

@daniCsorbaJB daniCsorbaJB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! 💯 I left just a couple of minor comments. Please let me know what you think

Copy link
Contributor

@daniCsorbaJB daniCsorbaJB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! 🚀 Thank you for the changes!

@sarahhaggarty sarahhaggarty force-pushed the abi-validation branch 2 times, most recently from d5beee2 to e04edd1 Compare June 16, 2025 11:54
@sarahhaggarty sarahhaggarty merged commit 8d94bb4 into 2-2-0-doc-update Jun 16, 2025
@sarahhaggarty sarahhaggarty deleted the abi-validation branch June 16, 2025 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants