From 77a2c815435fff9e4a573d3840de57fbaadfe34c Mon Sep 17 00:00:00 2001 From: Michael Osipov <michaelo@apache.org> Date: Thu, 21 Jul 2022 18:03:20 +0200 Subject: [PATCH] Prepare for Doxia 2.0.0 --- maven-plugin-report-plugin/pom.xml | 13 ++++++++---- .../src/main/java/org/DummyReport.java | 1 - .../plugin-report-with-javadoc-links/pom.xml | 3 --- .../src/it/plugin-report/pom.xml | 2 +- .../src/main/java/org/DummyReport.java | 1 - .../plugin/plugin/report/GoalRenderer.java | 4 ++-- .../plugin/report/PluginOverviewRenderer.java | 2 +- .../plugin/plugin/report/PluginReport.java | 2 -- maven-plugin-tools-generators/pom.xml | 2 +- .../test/resources/expected-testGoal-mojo.xml | 8 ++++---- pom.xml | 20 +++++-------------- 11 files changed, 23 insertions(+), 35 deletions(-) diff --git a/maven-plugin-report-plugin/pom.xml b/maven-plugin-report-plugin/pom.xml index f7143f0b..5c026e73 100644 --- a/maven-plugin-report-plugin/pom.xml +++ b/maven-plugin-report-plugin/pom.xml @@ -86,7 +86,12 @@ <dependency> <groupId>org.apache.maven.doxia</groupId> <artifactId>doxia-sink-api</artifactId> - <version>1.11.1</version> + <version>2.0.0-M8</version> + </dependency> + <dependency> + <groupId>org.apache.maven.doxia</groupId> + <artifactId>doxia-integration-tools</artifactId> + <version>2.0.0-M16</version> </dependency> <!-- shared --> @@ -98,8 +103,8 @@ <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> - <version>3.8.1</version> <!--same version as used by doxia site renderer --> + <version>3.12.0</version> </dependency> <!-- plexus --> <dependency> @@ -249,8 +254,8 @@ <settingsFile>src/it/settings.xml</settingsFile> <streamLogsOnFailures>true</streamLogsOnFailures> <filterProperties> - <sitePluginVersion>3.12.1</sitePluginVersion> - <projectInfoReportsPlugin>3.4.1</projectInfoReportsPlugin> + <sitePluginVersion>4.0.0-M13</sitePluginVersion> + <projectInfoReportsPlugin>4.0.0-M1-SNAPSHOT</projectInfoReportsPlugin> <antVersion>${antVersion}</antVersion> </filterProperties> <properties> diff --git a/maven-plugin-report-plugin/src/it/plugin-report-annotations/src/main/java/org/DummyReport.java b/maven-plugin-report-plugin/src/it/plugin-report-annotations/src/main/java/org/DummyReport.java index 66315bcd..1ac5ad70 100644 --- a/maven-plugin-report-plugin/src/it/plugin-report-annotations/src/main/java/org/DummyReport.java +++ b/maven-plugin-report-plugin/src/it/plugin-report-annotations/src/main/java/org/DummyReport.java @@ -108,7 +108,6 @@ protected MavenProject getProject() { */ public boolean canGenerateReport() { if (skip || skipReport) { - getLog().info("Maven Plugin Plugin Report generation skipped."); return false; } diff --git a/maven-plugin-report-plugin/src/it/plugin-report-with-javadoc-links/pom.xml b/maven-plugin-report-plugin/src/it/plugin-report-with-javadoc-links/pom.xml index cabb67cf..b7162360 100644 --- a/maven-plugin-report-plugin/src/it/plugin-report-with-javadoc-links/pom.xml +++ b/maven-plugin-report-plugin/src/it/plugin-report-with-javadoc-links/pom.xml @@ -100,9 +100,6 @@ under the License. <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> <version>@sitePluginVersion@</version> - <configuration> - <locales>en</locales> - </configuration> </plugin> </plugins> </build> diff --git a/maven-plugin-report-plugin/src/it/plugin-report/pom.xml b/maven-plugin-report-plugin/src/it/plugin-report/pom.xml index a6559802..1dcc9937 100644 --- a/maven-plugin-report-plugin/src/it/plugin-report/pom.xml +++ b/maven-plugin-report-plugin/src/it/plugin-report/pom.xml @@ -91,7 +91,7 @@ under the License. <artifactId>maven-site-plugin</artifactId> <version>@sitePluginVersion@</version> <configuration> - <locales>en,de,fr</locales> + <locales>default,de,fr</locales> </configuration> </plugin> </plugins> diff --git a/maven-plugin-report-plugin/src/it/plugin-report/src/main/java/org/DummyReport.java b/maven-plugin-report-plugin/src/it/plugin-report/src/main/java/org/DummyReport.java index c4018aee..a949dc1f 100644 --- a/maven-plugin-report-plugin/src/it/plugin-report/src/main/java/org/DummyReport.java +++ b/maven-plugin-report-plugin/src/it/plugin-report/src/main/java/org/DummyReport.java @@ -102,7 +102,6 @@ protected MavenProject getProject() { /** {@inheritDoc} */ public boolean canGenerateReport() { if (skip || skipReport) { - getLog().info("Maven Plugin Plugin Report generation skipped."); return false; } diff --git a/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/GoalRenderer.java b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/GoalRenderer.java index eac6c0c7..8e3b4655 100644 --- a/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/GoalRenderer.java +++ b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/GoalRenderer.java @@ -37,7 +37,7 @@ import org.apache.commons.lang3.StringUtils; import org.apache.maven.doxia.sink.Sink; import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet.Semantics; -import org.apache.maven.doxia.util.HtmlTools; +import org.apache.maven.doxia.util.DoxiaUtils; import org.apache.maven.plugin.descriptor.MojoDescriptor; import org.apache.maven.plugin.descriptor.Parameter; import org.apache.maven.plugin.logging.Log; @@ -260,7 +260,7 @@ private void renderParameterOverviewTableRow(Parameter parameter) { renderTableCellWithCode( format("parameter.name", parameter.getName()), // no need for additional URI encoding as it returns only URI safe characters - Optional.of("#" + HtmlTools.encodeId(parameter.getName()))); + Optional.of("#" + DoxiaUtils.encodeId(parameter.getName()))); // type Map.Entry<String, Optional<String>> type = getLinkedType(parameter, true); diff --git a/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java index 5189357e..3a36822e 100644 --- a/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java +++ b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java @@ -283,7 +283,7 @@ private void renderUsageSection(boolean hasMavenReport) { sb.append(" ...").append(Markup.EOL); sb.append("</project>"); - verbatimText(sb.toString()); + verbatimSource(sb.toString()); sink.paragraph(); linkPatternedText(getI18nString("configuration.end")); diff --git a/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java index 954363c5..544b9d27 100644 --- a/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java +++ b/maven-plugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java @@ -129,7 +129,6 @@ public class PluginReport extends AbstractMavenReport { @Override public boolean canGenerateReport() { if (skip) { - getLog().info("Maven Plugin Plugin Report generation skipped."); return false; } @@ -209,7 +208,6 @@ public String getOutputName() { */ private void generateMojosDocumentation(PluginDescriptor pluginDescriptor, Locale locale) throws MavenReportException { - if (pluginDescriptor.getMojos() != null) { for (MojoDescriptor descriptor : pluginDescriptor.getMojos()) { GoalRenderer renderer; diff --git a/maven-plugin-tools-generators/pom.xml b/maven-plugin-tools-generators/pom.xml index 13af689a..1ab4f4cf 100644 --- a/maven-plugin-tools-generators/pom.xml +++ b/maven-plugin-tools-generators/pom.xml @@ -57,7 +57,7 @@ <!-- other --> <dependency> <groupId>org.apache.velocity</groupId> - <artifactId>velocity</artifactId> + <artifactId>velocity-engine-core</artifactId> </dependency> <dependency> diff --git a/maven-plugin-tools-generators/src/test/resources/expected-testGoal-mojo.xml b/maven-plugin-tools-generators/src/test/resources/expected-testGoal-mojo.xml index 331787cb..ced84938 100644 --- a/maven-plugin-tools-generators/src/test/resources/expected-testGoal-mojo.xml +++ b/maven-plugin-tools-generators/src/test/resources/expected-testGoal-mojo.xml @@ -47,7 +47,7 @@ </li> </ul> <subsection name="Required Parameters"> - <table border="0" class="bodyTable"> + <table class="bodyTable"> <tr> <th>Name</th> <th>Type</th> @@ -81,7 +81,7 @@ </table> </subsection> <subsection name="Optional Parameters"> - <table border="0" class="bodyTable"> + <table class="bodyTable"> <tr> <th>Name</th> <th>Type</th> @@ -109,7 +109,7 @@ <subsection name="Parameter Details"> <h4> <strong> - <a name="dir"><dir></a> + <a id="dir"><dir></a> </strong> </h4> <div>Test parameter description</div> @@ -142,7 +142,7 @@ <hr/> <h4> <strong> - <a name="withoutSince"><withoutSince></a> + <a id="withoutSince"><withoutSince></a> </strong> </h4> <div>(no description)</div> diff --git a/pom.xml b/pom.xml index 2343a0c3..99027c91 100644 --- a/pom.xml +++ b/pom.xml @@ -103,8 +103,8 @@ <asmVersion>9.6</asmVersion> <plexusUtilsVersion>4.0.0</plexusUtilsVersion> <plexusXmlVersion>3.0.0</plexusXmlVersion> - <reportingApiVersion>3.1.1</reportingApiVersion> - <reportingImplVersion>3.2.0</reportingImplVersion> + <reportingApiVersion>4.0.0-M8</reportingApiVersion> + <reportingImplVersion>4.0.0-M13</reportingImplVersion> <compilerPluginVersion>3.11.0</compilerPluginVersion> <javadocPluginVersion>3.5.0</javadocPluginVersion> <project.build.outputTimestamp>2023-11-02T22:38:45Z</project.build.outputTimestamp> @@ -193,12 +193,6 @@ <groupId>org.apache.maven.reporting</groupId> <artifactId>maven-reporting-impl</artifactId> <version>${reportingImplVersion}</version> - <exclusions> - <exclusion> - <groupId>org.codehaus.plexus</groupId> - <artifactId>plexus-container-default</artifactId> - </exclusion> - </exclusions> </dependency> <dependency> @@ -230,24 +224,20 @@ <dependency> <groupId>org.codehaus.plexus</groupId> <artifactId>plexus-velocity</artifactId> - <version>1.2</version> + <version>2.0</version> <exclusions> <exclusion> <groupId>org.codehaus.plexus</groupId> <artifactId>plexus-container-default</artifactId> </exclusion> - <exclusion> - <groupId>velocity</groupId> - <artifactId>velocity</artifactId> - </exclusion> </exclusions> </dependency> <!-- other --> <dependency> <groupId>org.apache.velocity</groupId> - <artifactId>velocity</artifactId> - <version>1.7</version> + <artifactId>velocity-engine-core</artifactId> + <version>2.3</version> </dependency> <dependency>