Issue #10449 - Improve javadoc and jetty-documentation packaging (#10549)

* Issue #10449 - Improve jetty-documentation artifacts

+ -html.zip now has content
+ -javadoc.jar not produced locally
+ -source.jar not produced locally
+ attaching org.eclipse.jetty:javadoc:javadoc to jetty-documentation-<ver>-javadoc.jar instead

* Always run deploy:deploy

* Allow org.eclipse.jetty:javadoc:jar:javadoc to be found

* Don't skip asciidoctor on -DskipTests

* Bump javadoc plugin to 3.6.0

* Remove unused section

* Use proper phase

* Skip asciidoctor on -Pfast too

* Dump sources content in antrun (debugging codeql build)

* source:jar-no-fork is now default

* Revert "Dump sources content in antrun (debugging codeql build)"

This reverts commit 4bd9df1b1e.

.mvn/maven-build-cache-config.xml

@@ -58,6 +58,11 @@
             <goal>install</goal>
           </goals>
         </goalsList>
+        <goalsList artifactId="maven-deploy-plugin">
+          <goals>
+            <goal>deploy</goal>
+          </goals>
+        </goalsList>
       </goalsLists>
     </runAlways>
     <reconcile>

documentation/jetty-documentation/pom.xml

@@ -9,12 +9,13 @@
   <modelVersion>4.0.0</modelVersion>
   <artifactId>jetty-documentation</artifactId>
   <name>Documentation :: Guides</name>
-  <packaging>jar</packaging>
+  <packaging>pom</packaging>
 
   <properties>
     <bundle-symbolic-name>${project.groupId}</bundle-symbolic-name>
-    <asciidoctor.skip>${skipTests}</asciidoctor.skip>
     <jacoco.skip>true</jacoco.skip>
+    <javadoc.skip>true</javadoc.skip>
+    <sources.skip>true</sources.skip>
   </properties>
 
   <profiles>
@@ -88,6 +89,7 @@
     </resources>
     <plugins>
       <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
         <configuration>
           <fail>false</fail>
@@ -140,11 +142,9 @@
             <project-version>${project.version}</project-version>
             <maven-local-repo>${session.repositorySession.localRepository.basedir.absolutePath}</maven-local-repo>
             <version>${project.version}</version>
-<!--            <SRCDIR>./src/main/asciidoc</SRCDIR>-->
             <prog-guide>../programming-guide/index.html</prog-guide>
             <op-guide>../operations-guide/index.html</op-guide>
             <javadoc-url>https://eclipse.dev/jetty/javadoc/jetty-12</javadoc-url>
-<!--            <TIMESTAMP>2023-07-31T06:06:52Z</TIMESTAMP>-->
           </attributes>
         </configuration>
         <executions>
@@ -232,9 +232,23 @@
               <outputDirectory>${project.build.directory}/</outputDirectory>
             </configuration>
           </execution>
+          <execution>
+            <id>copy-javadoc-jar</id>
+            <phase>generate-resources</phase>
+            <goals>
+              <goal>copy-dependencies</goal>
+            </goals>
+            <configuration>
+              <includeGroupIds>org.eclipse.jetty</includeGroupIds>
+              <includeArtifactIds>javadoc</includeArtifactIds>
+              <classifier>javadoc</classifier>
+              <outputDirectory>${project.build.directory}/other-artifacts/</outputDirectory>
+            </configuration>
+          </execution>
         </executions>
       </plugin>
       <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-assembly-plugin</artifactId>
         <configuration>
           <descriptors>
@@ -251,6 +265,28 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>build-helper-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>attach-javadoc</id>
+            <phase>package</phase>
+            <goals>
+              <goal>attach-artifact</goal>
+            </goals>
+            <configuration>
+              <artifacts>
+                <artifact>
+                  <file>${project.build.directory}/other-artifacts/javadoc-${project.version}-javadoc.jar</file>
+                  <type>jar</type>
+                  <classifier>javadoc</classifier>
+                </artifact>
+              </artifacts>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 
@@ -359,6 +395,14 @@
       <type>zip</type>
       <optional>true</optional>
     </dependency>
+    <dependency>
+      <groupId>org.eclipse.jetty</groupId>
+      <artifactId>javadoc</artifactId>
+      <version>${project.version}</version>
+      <classifier>javadoc</classifier>
+      <type>jar</type>
+      <optional>true</optional>
+    </dependency>
     <dependency>
       <groupId>org.eclipse.jetty</groupId>
       <artifactId>jetty-infinispan-embedded-query</artifactId>

javadoc/pom.xml

@@ -143,8 +143,8 @@
         <artifactId>maven-javadoc-plugin</artifactId>
         <executions>
           <execution>
-            <id>build-javadoc</id>
-            <phase>prepare-package</phase>
+            <id>javadoc-build</id>
+            <phase>package</phase>
             <goals>
               <goal>jar</goal>
             </goals>

pom.xml

@@ -176,7 +176,7 @@
     <maven.invoker.plugin.version>3.6.0</maven.invoker.plugin.version>
     <groovy.version>4.0.6</groovy.version>
     <maven.jar.plugin.version>3.3.0</maven.jar.plugin.version>
-    <maven.javadoc.plugin.version>3.5.0</maven.javadoc.plugin.version>
+    <maven.javadoc.plugin.version>3.6.0</maven.javadoc.plugin.version>
     <maven.plugin-tools.version>3.9.0</maven.plugin-tools.version>
     <maven-plugin.plugin.version>3.9.0</maven-plugin.plugin.version>
     <maven.release.plugin.version>3.0.1</maven.release.plugin.version>
@@ -316,6 +316,20 @@
           </dependency>
         </dependencies>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-source-plugin</artifactId>
+        <inherited>true</inherited>
+        <executions>
+          <execution>
+            <id>attach-sources</id>
+            <phase>package</phase>
+            <goals>
+              <goal>jar-no-fork</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
       <plugin>
         <groupId>org.jacoco</groupId>
         <artifactId>jacoco-maven-plugin</artifactId>
@@ -2023,20 +2037,6 @@
               </execution>
             </executions>
           </plugin>
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-source-plugin</artifactId>
-            <inherited>true</inherited>
-            <executions>
-              <execution>
-                <id>attach-sources</id>
-                <phase>package</phase>
-                <goals>
-                  <goal>jar-no-fork</goal>
-                </goals>
-              </execution>
-            </executions>
-          </plugin>
           <plugin>
             <inherited>true</inherited>
             <groupId>org.apache.maven.plugins</groupId>
@@ -2097,11 +2097,6 @@
         <maven.repo.uri>https://repo.maven.apache.org/maven2/</maven.repo.uri>
         <home.start.timeout>120</home.start.timeout>
       </properties>
-      <modules>
-      <!-- FIXME: Do we want to keep this?
-        <module>javadoc</module>
-        -->
-      </modules>
       <build>
         <pluginManagement>
           <plugins>
@@ -2344,6 +2339,7 @@
       <id>fast</id>
       <properties>
         <skipTests>true</skipTests>
+        <asciidoctor.skip>true</asciidoctor.skip>
         <checkstyle.skip>true</checkstyle.skip>
         <enforcer.skip>true</enforcer.skip>
         <license.skip>true</license.skip>