Prepare for Doxia 2.0.0

apache · Oct 14, 2023 · 2a63924 · 2a63924
1 parent 679d822
commit 2a63924
Show file tree

Hide file tree

Showing 24 changed files with 916 additions and 63 deletions.
diff --git a/maven-plugin-annotations/pom.xml b/maven-plugin-annotations/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-annotations</artifactId>

diff --git a/maven-plugin-plugin/pom.xml b/maven-plugin-plugin/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <groupId>org.apache.maven.plugins</groupId>

diff --git a/maven-plugin-report-plugin/pom.xml b/maven-plugin-report-plugin/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <groupId>org.apache.maven.plugins</groupId>
@@ -82,7 +82,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-M13</version>
     </dependency>
 
     <!-- shared -->
@@ -94,8 +99,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>
@@ -245,8 +250,9 @@
               <settingsFile>src/it/settings.xml</settingsFile>
               <streamLogsOnFailures>true</streamLogsOnFailures>
               <filterProperties>
-                <sitePluginVersion>3.12.1</sitePluginVersion>
-                <projectInfoReportsPlugin>3.4.1</projectInfoReportsPlugin>
+                <sitePluginVersion>4.0.0-M10</sitePluginVersion>
+                <projectInfoReportsPlugin>4.0.0-M1-SNAPSHOT</projectInfoReportsPlugin>
+                <compilerPluginVersion>3.11.0</compilerPluginVersion>
                 <antVersion>${antVersion}</antVersion>
               </filterProperties>
               <properties>

diff --git a/...-plugin-report-plugin/src/it/plugin-report-annotations/src/main/java/org/DummyReport.java b/...-plugin-report-plugin/src/it/plugin-report-annotations/src/main/java/org/DummyReport.java
@@ -107,21 +107,18 @@ protected MavenProject getProject() {
      * {@inheritDoc}
      */
     public boolean canGenerateReport() {
+        if (skip || skipReport) {
+            getLog().info("Maven Plugin Plugin Report generation skipped.");
+            return false;
+        }
+
         return true;
     }
 
     /**
      * {@inheritDoc}
      */
     protected void executeReport(Locale locale) throws MavenReportException {
-        if (!canGenerateReport()) {
-            return;
-        }
-        if (skip || skipReport) {
-            getLog().info("Maven Plugin Plugin Report generation skipped.");
-            return;
-        }
-
         // Generate the plugin's documentation
         generatePluginDocumentation(locale);
     }

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
@@ -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
@@ -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
@@ -101,19 +101,16 @@ protected MavenProject getProject() {
 
     /** {@inheritDoc} */
     public boolean canGenerateReport() {
+        if (skip || skipReport) {
+            getLog().info("Maven Plugin Plugin Report generation skipped.");
+            return false;
+        }
+
         return true;
     }
 
     /** {@inheritDoc} */
     protected void executeReport(Locale locale) throws MavenReportException {
-        if (!canGenerateReport()) {
-            return;
-        }
-        if (skip || skipReport) {
-            getLog().info("Maven Plugin Plugin Report generation skipped.");
-            return;
-        }
-
         // Generate the plugin's documentation
         generatePluginDocumentation(locale);
     }

diff --git a/...lugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/GoalRenderer.java b/...lugin-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/...rt-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginOverviewRenderer.java b/...rt-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/...lugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java b/...lugin-report-plugin/src/main/java/org/apache/maven/plugin/plugin/report/PluginReport.java
@@ -205,7 +205,6 @@ public String getOutputName() {
      */
     private void generateMojosDocumentation(PluginDescriptor pluginDescriptor, Locale locale)
             throws MavenReportException {
-
         if (pluginDescriptor.getMojos() != null) {
             for (MojoDescriptor descriptor : pluginDescriptor.getMojos()) {
                 GoalRenderer renderer;
@@ -222,7 +221,7 @@ private void generateMojosDocumentation(PluginDescriptor pluginDescriptor, Local
                             disableInternalJavadocLinkValidation,
                             getLog());
                 } catch (IOException e) {
-                    throw new MavenReportException("Can not generate sink for mojo " + descriptor.getGoal(), e);
+                    throw new MavenReportException("Cannot generate sink for mojo " + descriptor.getGoal(), e);
                 }
                 renderer.render();
             }

diff --git a/maven-plugin-tools-annotations/pom.xml b/maven-plugin-tools-annotations/pom.xml
@@ -22,7 +22,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-annotations</artifactId>

diff --git a/maven-plugin-tools-api/pom.xml b/maven-plugin-tools-api/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-api</artifactId>

diff --git a/maven-plugin-tools-generators/pom.xml b/maven-plugin-tools-generators/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.plugin-tools</groupId>
     <artifactId>maven-plugin-tools</artifactId>
-    <version>3.9.1-SNAPSHOT</version>
+    <version>3.10.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>maven-plugin-tools-generators</artifactId>
@@ -57,7 +57,7 @@
     <!-- other -->
     <dependency>
       <groupId>org.apache.velocity</groupId>
-      <artifactId>velocity</artifactId>
+      <artifactId>velocity-engine-core</artifactId>
     </dependency>
 
     <dependency>