[
https://issues.apache.org/jira/browse/FLINK-35154?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17864334#comment-17864334
]
Samrat Deb edited comment on FLINK-35154 at 7/9/24 6:38 PM:
------------------------------------------------------------
a)
Based on the [release notes of the Javadoc
Plugin|https://github.com/apache/maven-javadoc-plugin/releases], upgrading from
v2.9.1 to 3.x offers numerous benefits, including improved compatibility,
enhanced features, and better performance. Here are the key improvements:
* {*}2.x{*}: Primarily supports older Java versions.
* {*}3.x{*}: Fully supports newer Java versions, including Java 11 and beyond,
aligning with Flink's support for newer Java versions.
* {*}2.x{*}: Limited configuration options with basic Javadoc generation
capabilities.
* {*}3.x{*}: Enhanced configuration options, improved handling of module
systems, and support for new Javadoc features and tags introduced in recent
Java versions.
* Bug fixes and performance improvements in 3.x
I am suggesting to go to 3.7.0 for following reasons :
# Flink supports newer Java versions, and upgrading to Javadoc Plugin 3.x
ensures compatibility and leverages new Java features.
# The Javadoc Plugin is used solely for generating Java API documentation and
is not a runtime requirement for Flink applications. Any issue due to major
version bump will be caught before release of 1.20 during api doc generation.
# If any issues arise during the Javadoc generation process after upgrading to
3.x, we can easily revert to the previous version (2.10.x) without affecting
the overall build process.
b) from the logs of Github Actions:
{code:java}
1 error 38333100 warnings 38334Error: Error while creating javadoc
report: 38335Exit code: 1 -
/root/flink/flink-end-to-end-tests/flink-confluent-schema-registry/target/generated-sources/example/avro/EventType.java:8:
error: type GenericEnumSymbol does not take parameters 38336public enum
EventType implements org.apache.avro.generic.GenericEnumSymbol<EventType> {
38337 ^
38338/root/flink/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroup.java:33:
warning - Tag @link: reference not found: ConfigOptionsDocGenerator
38339/root/flink/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/testutils/junit/extensions/parameterized/Parameter.java:34:
warning - Tag @link: reference not found: Parameterized.Parameter
38340/root/flink/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/core/testutils/CustomExtension.java:46:
warning - Missing closing '}' character for inline tag: "{@code 38341
public class Test{ 38342 CustomExtension eachCustom = new
CustomExtensionImpl1(); 38343 CustomExtension allCustom = new
CustomExtensionImpl2();"
38344/root/flink/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/core/testutils/CustomExtension.java:46:
warning - @RegisterExtension is an unknown tag. {code}
{code:java}
Command line was: /usr/lib/jvm/java-8-openjdk-amd64/jre/../bin/javadoc
"-Xdoclint:none --allow-script-in-comments" -Xdoclint:none @options @packages
@argfile 38444 38445Refer to the generated Javadoc files in
'/root/flink/target/site/apidocs' dir. 38446
38447org.apache.maven.reporting.MavenReportException: 38448Exit code: 1 -
/root/flink/flink-end-to-end-tests/flink-confluent-schema-registry/target/generated-sources/example/avro/EventType.java:8:
error: type GenericEnumSymbol does not take parameters 38449public enum
EventType implements org.apache.avro.generic.GenericEnumSymbol<EventType> {
38450 ^
38451/root/flink/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroup.java:33:
warning - Tag @link: reference not found: ConfigOptionsDocGenerator
38452/root/flink/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/testutils/junit/extensions/parameterized/Parameter.java:34:
warning - Tag @link: reference not found: Parameterized.Parameter
38453/root/flink/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/core/testutils/CustomExtension.java:46:
warning - Missing closing '}' character for inline tag: "{@code 38454
public class Test{ 38455 CustomExtension eachCustom = new
CustomExtensionImpl1(); 38456 CustomExtension allCustom = new
CustomExtensionImpl2();"
38457/root/flink/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/core/testutils/CustomExtension.java:46:
warning - @RegisterExtension is an unknown tag. {code}
I think the action is failing silently and leading to broken documentation .
Please validate if my speculation is correct.
reference :
1.
[https://github.com/apache/flink/actions/runs/9848601763/job/27190828070#step:5:38336]
2.
[https://github.com/apache/flink/actions/runs/9848601763/job/27190828070#step:5:38559]
was (Author: samrat007):
a)
Based on the [release notes of the Javadoc
Plugin|https://github.com/apache/maven-javadoc-plugin/releases], upgrading from
v2.9.1 to 3.x offers numerous benefits, including improved compatibility,
enhanced features, and better performance. Here are the key improvements:
* {*}2.x{*}: Primarily supports older Java versions.
* {*}3.x{*}: Fully supports newer Java versions, including Java 11 and beyond,
aligning with Flink's support for newer Java versions.
* {*}2.x{*}: Limited configuration options with basic Javadoc generation
capabilities.
* {*}3.x{*}: Enhanced configuration options, improved handling of module
systems, and support for new Javadoc features and tags introduced in recent
Java versions.
* Bug fixes and performance improvements in 3.x
I am suggesting to go to 3.7.0 for following reasons :
# Flink supports newer Java versions, and upgrading to Javadoc Plugin 3.x
ensures compatibility and leverages new Java features.
# The Javadoc Plugin is used solely for generating Java API documentation and
is not a runtime requirement for Flink applications. Any issue due to major
version bump will be caught before release of 1.20 during api doc generation.
# If any issues arise during the Javadoc generation process after upgrading to
3.x, we can easily revert to the previous version (2.10.x) without affecting
the overall build process.
b) from the logs of Github Actions:
{code:java}
1 error 38333100 warnings 38334Error: Error while creating javadoc
report: 38335Exit code: 1 -
/root/flink/flink-end-to-end-tests/flink-confluent-schema-registry/target/generated-sources/example/avro/EventType.java:8:
error: type GenericEnumSymbol does not take parameters 38336public enum
EventType implements org.apache.avro.generic.GenericEnumSymbol<EventType> {
38337 ^
38338/root/flink/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroup.java:33:
warning - Tag @link: reference not found: ConfigOptionsDocGenerator
38339/root/flink/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/testutils/junit/extensions/parameterized/Parameter.java:34:
warning - Tag @link: reference not found: Parameterized.Parameter
38340/root/flink/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/core/testutils/CustomExtension.java:46:
warning - Missing closing '}' character for inline tag: "{@code 38341
public class Test{ 38342 CustomExtension eachCustom = new
CustomExtensionImpl1(); 38343 CustomExtension allCustom = new
CustomExtensionImpl2();"
38344/root/flink/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/core/testutils/CustomExtension.java:46:
warning - @RegisterExtension is an unknown tag. {code}
{code:java}
Command line was: /usr/lib/jvm/java-8-openjdk-amd64/jre/../bin/javadoc
"-Xdoclint:none --allow-script-in-comments" -Xdoclint:none @options @packages
@argfile 38444 38445Refer to the generated Javadoc files in
'/root/flink/target/site/apidocs' dir. 38446
38447org.apache.maven.reporting.MavenReportException: 38448Exit code: 1 -
/root/flink/flink-end-to-end-tests/flink-confluent-schema-registry/target/generated-sources/example/avro/EventType.java:8:
error: type GenericEnumSymbol does not take parameters 38449public enum
EventType implements org.apache.avro.generic.GenericEnumSymbol<EventType> {
38450 ^
38451/root/flink/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroup.java:33:
warning - Tag @link: reference not found: ConfigOptionsDocGenerator
38452/root/flink/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/testutils/junit/extensions/parameterized/Parameter.java:34:
warning - Tag @link: reference not found: Parameterized.Parameter
38453/root/flink/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/core/testutils/CustomExtension.java:46:
warning - Missing closing '}' character for inline tag: "{@code 38454
public class Test{ 38455 CustomExtension eachCustom = new
CustomExtensionImpl1(); 38456 CustomExtension allCustom = new
CustomExtensionImpl2();"
38457/root/flink/flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/core/testutils/CustomExtension.java:46:
warning - @RegisterExtension is an unknown tag. {code}
I think the action is failing silently and leading to broken documentation .
Please validate if my speculation is correct.
reference :
1.
[https://github.com/apache/flink/actions/runs/9848601763/job/27190828070#step:5:38336]
2.
https://github.com/apache/flink/actions/runs/9848601763/job/27190828070#step:5:38559
I think its failing silently .
> Javadoc aggregate fails
> -----------------------
>
> Key: FLINK-35154
> URL: https://issues.apache.org/jira/browse/FLINK-35154
> Project: Flink
> Issue Type: Bug
> Reporter: Dmitriy Linevich
> Priority: Minor
> Labels: pull-request-available
>
> Javadoc plugin fails with error. Using
> {code:java}
> javadoc:aggregate{code}
> ERROR:
> {code:java}
> [WARNING] The requested profile "include-hadoop" could not be activated
> because it does not exist.
> [WARNING] The requested profile "arm" could not be activated because it does
> not exist.
> [ERROR] Failed to execute goal
> org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:aggregate (default-cli)
> on project flink-parent: An error has occurred in JavaDocs report generation:
> [ERROR] Exit code: 1 -
> /{flinkProjectDir}/flink-end-to-end-tests/flink-confluent-schema-registry/target/generated-sources/example/avro/EventType.java:8:
> error: type GenericEnumSymbol does not take parameters
> [ERROR] public enum EventType implements
> org.apache.avro.generic.GenericEnumSymbol<EventType> {
> [ERROR] {code}
>
> For our flink 1.17 ERROR
> {code:java}
> [ERROR]
> /{flinkProjectDir}/flink-connectors/flink-sql-connector-hive-3.1.3/src/main/java/org/apache/hadoop/hive/metastore/HiveMetaStoreClient.java:21:
> error: cannot find symbol
> [ERROR] import static
> org.apache.hadoop.hive.metastore.Warehouse.DEFAULT_DATABASE_NAME;
> [ERROR] ^
> [ERROR] symbol: static DEFAULT_DATABASE_NAME
> [ERROR] location: class{code}
>
> Need to increase version of javadoc plugin from 2.9.1 to 2.10.4 (In current
> version exists bug same with
> [this|https://github.com/checkstyle/checkstyle/issues/291])
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
