Skip to content
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

Ensure binary compatibility for every change on CI. #554

Open
psteiger opened this issue Apr 16, 2023 · 3 comments
Open

Ensure binary compatibility for every change on CI. #554

psteiger opened this issue Apr 16, 2023 · 3 comments

Comments

@psteiger
Copy link
Contributor

Going forward, I think we should use a tool such as the binary compatibility validator plugin to avoid making unconscious binary-incompatible changes to the library API.

@psteiger
Copy link
Contributor Author

I see we previously introduced japicmp plugin (7c48b52) for checking binary/source compatibility.

However, usage of japicmp in CI was lost in Travis -> GitHub Actions migration (0f657d4)

Wondering what's the best way forward:

  1. We could just reintroduce the task in the GitHub Actions CI, or
  2. Use the JetBrains Binary Compatibility Validator plugin now that we are fully Kotlin on the Android RIBs library.

@psteiger psteiger changed the title Introduce binary compatibility validator plugin Ensure binary compatibility for every change on CI. Apr 17, 2023
@tyvsmith
Copy link
Member

We should re-enable japicmp for the short term, then discuss the trade-offs between the Jetbrains solution for a longer term approach. @jbarr21 You originally chose japicmp, was that only because it needed compat between a java to kt migration?

@jbarr21
Copy link
Contributor

jbarr21 commented Apr 18, 2023

i wasn't aware of the latter at the time & had seen other popular community libraries using japicmp, so that was the initial reasoning for going with that tool

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

No branches or pull requests

3 participants