Improve JapiCmp: avoid misses, improve reporting and exclusions #162
Conversation
This file contains 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
This commit improves the japicmp integration in the build: 1) Add a finalizedBy task that prints a filtered report The basic text report uses * and ! as markers for binary and source incompatible changes respectively. Additionally, a MODIFIED class is marked with ***. This task attempts at pinpointing the incompatible changes only in the report, and printing these lines. This report is called out in the "how to fix" tip in the CI preliminary step. 2) Ensure sourceModified changes are considered See reactor/reactor#722. If a change is binary compatible but not source compatible, using `onlyBinaryCompatibleModified = true` will mask the issue. This change uses `onlyModified = true` instead. This is slightly more verbose, but this is alleviated by (1). 3) Update japicmp-gradle-plugin, exclude NEW_DEFAULT_METHOD as a whole Since japicmp-grale-plugin v0.4.1 the new `compatibilityChangeExcludes` parameter allows us to ignore all occurrences of a default method added to an interface, instead of having to exclude each such method one by one.
simonbasle
added
the
type/chore
violetagg
approved these changes
Sep 27, 2022
|
@simonbasle this PR seems to have been merged on a maintenance branch, please ensure the change is merge-forwarded to intermediate maintenance branches and up to |
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.
This commit improves the japicmp integration in the build:
The basic text report uses * and ! as markers for binary and source
incompatible changes respectively. Additionally, a MODIFIED class is
marked with ***. This task attempts at pinpointing the incompatible
changes only in the report, and printing these lines.
This report is called out in the "how to fix" tip in the CI preliminary
step.
See reactor/reactor#722.
If a change is binary compatible but not source compatible, using
onlyBinaryCompatibleModified = truewill mask the issue. Thischange uses
onlyModified = trueinstead. This is slightly moreverbose, but this is alleviated by (1).
Since japicmp-grale-plugin v0.4.1 the new
compatibilityChangeExcludesparameter allows us to ignore all occurrences of a default method added
to an interface, instead of having to exclude each such method one by
one.