[FLINK-36207][build] Disables deprecated API from japicmp #25285
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
XComp
commented
Sep 4, 2024
| <exclude>@org.apache.flink.annotation.Experimental</exclude> | ||
| <exclude>@org.apache.flink.annotation.PublicEvolving</exclude> | ||
| <exclude>@org.apache.flink.annotation.Internal</exclude> | ||
| <!-- MARKER: start exclusions; these will be wiped by tools/releasing/update_japicmp_configuration.sh --> | ||
| <!-- Mark these 2 methods to @Internal. Tracked under FLINK-34130, should be removed in 2.0 --> | ||
| <exclude>org.apache.flink.configuration.Configuration#getBytes(java.lang.String,byte[])</exclude> | ||
| <exclude>org.apache.flink.configuration.Configuration#setBytes(java.lang.String,byte[])</exclude> | ||
| <!-- FLINK-35886: WatermarksWithIdleness constructor was marked as deprecated --> | ||
| <exclude>org.apache.flink.api.common.eventtime.WatermarksWithIdleness</exclude> |
There was a problem hiding this comment.
I struggled to get my head around why this exclusion was necessary. It's a change that was introduced in 2.0 (see FLINK-35886) which deprecated the constructor.
My reasoning now is that the reference data (that was generated as part of the 1.20 release branch creation) didn't include that deprecation, yet. Excluding deprecated APIs now makes them be ignored in the check, i.e. the API disappears from the compare-to set (master HEAD) but is still present in the base set (1.20.0). 🤔
xintongsong
approved these changes
Sep 11, 2024
There was a problem hiding this comment.
Thanks, @XComp. LGTM. Please make sure to resolve the conflicts before merging.
The japicmp plugin doesn't seem to work well with Scala annotations (more specifically @scala.deprecated). But we're planning to remove the Scala code as part of the 2.0 release, anyway. Hence, excluding all *scala files should be good enough.
|
@flinkbot run azure |
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.
What is the purpose of the change
The japicmp plugin doesn't seem to work well with Scala annotations (more specifically @scala.deprecated). But we're planning to remove the Scala code as part of the 2.0 release, anyway. Hence, excluding all *scala files should be good enough.
Brief change log
Verifying this change
Check the corresponding branches the workflows ran on to see the changes.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): noDocumentation