Java api compatibility check report#613
Open
tfkfan wants to merge 1 commit intoydb-platform:masterfrom
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #613 +/- ##
============================================
- Coverage 68.92% 68.88% -0.05%
- Complexity 3131 3134 +3
============================================
Files 355 359 +4
Lines 15304 15328 +24
Branches 1621 1621
============================================
+ Hits 10549 10558 +9
- Misses 4094 4108 +14
- Partials 661 662 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds automated backward-compatibility checking for the Java SDK using Revapi, publishing a text report (via a FreeMarker template) back to pull requests via a GitHub Actions workflow.
Changes:
- Add Revapi Maven plugin configuration (with text reporter) to generate per-artifact breaking-change reports.
- Add a FreeMarker template used by the text reporter to format a Markdown-friendly report.
- Add a GitHub Actions workflow to run Revapi on PRs and post a sticky PR comment with the merged report.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
pom.xml |
Introduces Revapi plugin + reporter configuration and related dependency management. |
config/revapi-report-template.ftl |
Adds the FreeMarker template used to format the text report. |
.github/workflows/breaking.yaml |
Adds CI job to run Revapi and comment a merged compatibility report on PRs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
7b9dea0 to
28ac811
Compare
This file contains hidden or 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
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.
Backward compatibility report
Added revapi maven plugin https://revapi.org/revapi-site/main/index.html , ftl template and corresponding github action to provide backward compatibility report
Short description: revapi compares two compiled versions of module/library only. So the 'install' goal is required to make it work. You can provide versions to compare as arguments:
Revapi supports web and txt reports. Last one is used here with freemarker template.
Block above is required for packages scan process management
Comment looks this way:
