You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by GitBox <gi...@apache.org> on 2022/10/26 15:38:05 UTC
[GitHub] [maven-plugin-tools] kwin opened a new pull request, #162: [MPLUGIN-433] Allow to disable link validation
kwin opened a new pull request, #162:
URL: https://github.com/apache/maven-plugin-tools/pull/162
Also validate internal links to javadocs in mojo/parameter description and deprecated
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-plugin-tools] kwin merged pull request #162: [MPLUGIN-433] Allow to disable link validation
Posted by GitBox <gi...@apache.org>.
kwin merged PR #162:
URL: https://github.com/apache/maven-plugin-tools/pull/162
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-plugin-tools] slawekjaranowski commented on pull request #162: [MPLUGIN-433] Allow to disable link validation
Posted by GitBox <gi...@apache.org>.
slawekjaranowski commented on PR #162:
URL: https://github.com/apache/maven-plugin-tools/pull/162#issuecomment-1293404350
What do you think about adding IT test for such options?
By the way we don't have any IT tests for javadoc links ... or I don't see.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-plugin-tools] slawekjaranowski commented on a diff in pull request #162: [MPLUGIN-433] Allow to disable link validation
Posted by GitBox <gi...@apache.org>.
slawekjaranowski commented on code in PR #162:
URL: https://github.com/apache/maven-plugin-tools/pull/162#discussion_r1006688605
##########
maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/report_old/PluginReport.java:
##########
@@ -218,6 +218,19 @@
readonly = true )
private File enhancedPluginXmlFile;
+ /**
+ * In case the internal javadoc site has not been generated when running this report goal
+ * (e.g. when using an aggregator javadoc report) link validation needs to be disabled by setting
+ * this value to {@code true}.
+ * This might have the drawback that some links being generated in the report might be broken
+ * in case not all parameter types and javadoc link references are resolvable through the sites being given to
+ * {@link DescriptorGeneratorMojo}.
+ *
+ * @since 3.7.0
+ */
+ @Parameter
+ private boolean disableInternalJavadocLinkValidation;
Review Comment:
ok, no problem here
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-plugin-tools] kwin commented on a diff in pull request #162: [MPLUGIN-433] Allow to disable link validation
Posted by GitBox <gi...@apache.org>.
kwin commented on code in PR #162:
URL: https://github.com/apache/maven-plugin-tools/pull/162#discussion_r1006648509
##########
maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/report_old/PluginReport.java:
##########
@@ -218,6 +218,19 @@
readonly = true )
private File enhancedPluginXmlFile;
+ /**
+ * In case the internal javadoc site has not been generated when running this report goal
+ * (e.g. when using an aggregator javadoc report) link validation needs to be disabled by setting
+ * this value to {@code true}.
+ * This might have the drawback that some links being generated in the report might be broken
+ * in case not all parameter types and javadoc link references are resolvable through the sites being given to
+ * {@link DescriptorGeneratorMojo}.
+ *
+ * @since 3.7.0
+ */
+ @Parameter
+ private boolean disableInternalJavadocLinkValidation;
Review Comment:
A lot of parameters have been added in 3.7.0 (currently both in deprecated and new report goal) not only this one. I don't think that this does any harm here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-plugin-tools] kwin commented on pull request #162: [MPLUGIN-433] Allow to disable link validation
Posted by GitBox <gi...@apache.org>.
kwin commented on PR #162:
URL: https://github.com/apache/maven-plugin-tools/pull/162#issuecomment-1293618590
I now also added a proper IT in https://github.com/apache/maven-plugin-tools/pull/162/commits/6b564c8aaf89af4776ffb7898e2a86a4ce400a4f with some basic checks on generated links.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-plugin-tools] slawekjaranowski commented on a diff in pull request #162: [MPLUGIN-433] Allow to disable link validation
Posted by GitBox <gi...@apache.org>.
slawekjaranowski commented on code in PR #162:
URL: https://github.com/apache/maven-plugin-tools/pull/162#discussion_r1006646150
##########
maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/report_old/PluginReport.java:
##########
@@ -218,6 +218,19 @@
readonly = true )
private File enhancedPluginXmlFile;
+ /**
+ * In case the internal javadoc site has not been generated when running this report goal
+ * (e.g. when using an aggregator javadoc report) link validation needs to be disabled by setting
+ * this value to {@code true}.
+ * This might have the drawback that some links being generated in the report might be broken
+ * in case not all parameter types and javadoc link references are resolvable through the sites being given to
+ * {@link DescriptorGeneratorMojo}.
+ *
+ * @since 3.7.0
+ */
+ @Parameter
+ private boolean disableInternalJavadocLinkValidation;
Review Comment:
I would like not to add new parameters to deprecated report - what do you think?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-plugin-tools] slawekjaranowski commented on pull request #162: [MPLUGIN-433] Allow to disable link validation
Posted by GitBox <gi...@apache.org>.
slawekjaranowski commented on PR #162:
URL: https://github.com/apache/maven-plugin-tools/pull/162#issuecomment-1293318036
Please also rebase with current codebase ... build should will be ok 😄
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-plugin-tools] kwin commented on pull request #162: [MPLUGIN-433] Allow to disable link validation
Posted by GitBox <gi...@apache.org>.
kwin commented on PR #162:
URL: https://github.com/apache/maven-plugin-tools/pull/162#issuecomment-1293356760
> Please also rebase with current codebase
Done.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven-plugin-tools] kwin commented on pull request #162: [MPLUGIN-433] Allow to disable link validation
Posted by GitBox <gi...@apache.org>.
kwin commented on PR #162:
URL: https://github.com/apache/maven-plugin-tools/pull/162#issuecomment-1293525138
> By the way we don't have any IT tests for javadoc links ... or I don't see.
Not end2end but there is a lot of unit tests and https://github.com/apache/maven-plugin-tools/blob/master/maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/javadoc/JavadocSiteIT.java which checks that the links being created actually work against a Javadoc site created from JDK8/11/17.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org