build: check binary compatibility against published releases - #465
Open
jainruchir wants to merge 1 commit into
Open
jainruchir wants to merge 1 commit into
jainruchir wants to merge 1 commit into
Conversation
Compare core and provider APIs with the latest stable Maven Central release during check. Add TestKit coverage, including the published 0.8.14 to 0.8.15 builder regression, and document baseline overrides and intentional changes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Ruchir Jain <122954065+jainruchir@users.noreply.github.com>
Member
|
Thanks for adding this! I'll review it. |
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.
Summary
Closes #463.
Add a japicmp binary compatibility gate for
java-spiffe-coreandjava-spiffe-provider, wired intocheckand therefore the existing CI builds. This catches changes that still compile from source but break previously compiled consumers, such as the builder return-type change in #377.major.minor.patchrelease from Maven Central automatically, with-PbaselineVersion=...for maintenance branches.build/reports/japicmp/.-PbaselineVersion=noneexplicitly opts out for a first-ever release.Existing unreleased change
The check found that
RetryHandler.scheduleRetry(Runnable)already changed fromvoidtobooleanon main in 8cef441. This PR records that exact method as an exclusion and documents its ABI impact in the changelog; it does not modify the retry implementation.Please review whether to accept that existing break or restore compatibility separately. More generally, does the proposed method/field exclusion plus changelog policy match how you would like to handle intentional ABI changes?
Testing
On macOS arm64:
./gradlew buildpasses on JDK 25, including 608 existing unit tests and nine new Gradle TestKit tests.X509SourceOptionsBuilderand changedbuilder()signature fail the gate.Local commands (no SPIRE agent required):
./gradlew :java-spiffe-core:japicmp :java-spiffe-provider:japicmp ./gradlew binaryCompatibilityTest ./gradlew binaryCompatibilityTest --tests '*detectsPublishedBuilderRegressionFrom0814To0815'SPIRE integration tests were not run; this changes build verification only.