ci: break build on incompatible modifications

[javier-godoy]

It has come to our attention that #94 contains a binary-compatibility breaking change that was not identified during the review phase. To prevent similar regressions, I am rolling out japicmp across all add-ons and libraries. This will automate binary-compatibility checks and ensure we catch breaking changes during the CI process.

Had we run this tool on the PR, it would have immediately reported the incompatibility and blocked the release.

[ERROR] Failed to execute goal com.github.siom79.japicmp:japicmp-maven-plugin:0.25.4:cmp (default) on project backend-core-model: There is at least one incompatibility: com.flowingcode.backendcore.model.QuerySpec.addConstraint(com.flowingcode.backendcore.model.Constraint):METHOD_RETURN_TYPE_CHANGED,com.flowingcode.backendcore.model.QuerySpec.addOrder(java.lang.String,com.flowingcode.backendcore.model.QuerySpec$Order):METHOD_RETURN_TYPE_CHANGED,com.flowingcode.backendcore.model.QuerySpec.addOrder(java.lang.String):METHOD_RETURN_TYPE_CHANGED,com.flowingcode.backendcore.model.QuerySpec.setFirstResult(java.lang.Integer):METHOD_RETURN_TYPE_CHANGED,com.flowingcode.backendcore.model.QuerySpec.setMaxResult(java.lang.Integer):METHOD_RETURN_TYPE_CHANGED,com.flowingcode.backendcore.model.QuerySpec.setOrders(java.util.Map):METHOD_RETURN_TYPE_CHANGED,com.flowingcode.backendcore.model.QuerySpec.setReturnedAttributes(java.lang.String[]):METHOD_RETURN_TYPE_CHANGED

Summary by CodeRabbit

• Chores
  • Enhanced the build process to verify API compatibility across releases, ensuring consistent interfaces and preventing unintended breaking changes.

[coderabbitai]

Walkthrough

Added japicmp-maven-plugin to the Maven build configuration with break-on conditions for binary-incompatible, source-incompatible, and semantic-versioning violations all enabled. The plugin is wired to the verify phase, causing the build to fail on API compatibility changes.

Changes

Cohort / File(s)	Summary
Maven Plugin Configuration pom.xml	Added japicmp-maven-plugin with three break-on conditions (binary-incompatible, source-incompatible, semantic-versioning) configured to true and execution bound to verify phase for API compatibility verification.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and accurately describes the main change: adding japicmp to break the build on incompatible API modifications.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch ci-japicmp

Important

Action Needed: IP Allowlist Update

If your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:

• ✨ 136.113.208.247/32 (new)
• 34.170.211.100/32
• 35.222.179.152/32

Reviews will stop working after February 8, 2026 if the new IP is not added to your allowlist.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud