-
Notifications
You must be signed in to change notification settings - Fork 14
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
chore(java): add api compat check #1335
Conversation
Compares the current generated code with the latest published version (snapshots included). Run with `./gradlew :api:japicmp`. In case on an incompatibility, the build will fail. The report should be available under `api/build/reports`.
✅ Deploy Preview for api-clients-automation ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
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.
😮 nice!
btw should be gitignore the bin for the playground/tests folders?
Yes, it shouldn't be included indeed, gradle should build the folder at runtime |
4f9f0b5
to
eb612b7
Compare
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.
Nice ! Would be very useful for other languages too, but I have never heard of this library before, not sure if it's available elsewhere
Yes indeed! especially for strongly typed languages! I know that similar ideas exists for other languages such as kotlin, go and rust. It is definitely worth to look more into this! |
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.
Nice !
Looks like this is pretty fast too run also :)
algolia/api-clients-automation#1335 Co-authored-by: Mouaad Aallam <Mouaad@Aallam.com>
🧭 What and Why
Compares the current generated code with the latest published version (snapshots included).
To public API check is done using japicmp-gradle-plugin.
In case on an incompatibility, the build will fail. The report should be available under
api/build/reports
.🎟 JIRA Ticket: APIC-645
Changes included:
api
package to Java API client:api:japicmp