Issue #8895 - Introduce jetty-home-<ver>-with-docs.zip

Signed-off-by: Joakim Erdfelt <[email protected]>
jetty · Nov 14, 2022 · 67629e6 · 67629e6
1 parent df265e0
commit 67629e6
Show file tree

Hide file tree

Showing 5 changed files with 114 additions and 9 deletions.
diff --git a/javadoc/pom.xml b/javadoc/pom.xml
@@ -126,7 +126,7 @@
             <id>build-javadoc</id>
             <phase>prepare-package</phase>
             <goals>
-              <goal>javadoc</goal>
+              <goal>jar</goal>
             </goals>
             <configuration>
               <doctitle>Eclipse Jetty API Doc - v${project.version}</doctitle>

diff --git a/jetty-home/pom.xml b/jetty-home/pom.xml
@@ -13,6 +13,7 @@
   <properties>
     <assembly-directory>${basedir}/target/jetty-home</assembly-directory>
     <source-assembly-directory>${basedir}/target/jetty-home-sources</source-assembly-directory>
+    <docs-assembly-directory>${basedir}/target/jetty-home-with-docs</docs-assembly-directory>
     <jetty-setuid-version>1.0.4</jetty-setuid-version>
     <spotbugs.skip>true</spotbugs.skip>
   </properties>
@@ -120,7 +121,6 @@
               </artifactItems>
             </configuration>
           </execution>
-
           <execution>
             <id>copy-lib-deps</id>
             <phase>generate-resources</phase>
@@ -508,6 +508,42 @@
               <outputDirectory>${assembly-directory}</outputDirectory>
             </configuration>
           </execution>
+          <execution>
+            <id>unpack-documentation</id>
+            <phase>generate-resources</phase>
+            <goals>
+              <goal>unpack</goal>
+            </goals>
+            <configuration>
+              <artifactItems>
+                <artifactItem>
+                  <groupId>org.eclipse.jetty.documentation</groupId>
+                  <artifactId>jetty-documentation</artifactId>
+                  <version>${project.version}</version>
+                  <type>jar</type>
+                </artifactItem>
+              </artifactItems>
+              <outputDirectory>${docs-assembly-directory}/docs</outputDirectory>
+            </configuration>
+          </execution>
+          <execution>
+            <id>unpack-javadoc-aggregate</id>
+            <phase>generate-resources</phase>
+            <goals>
+              <goal>unpack</goal>
+            </goals>
+            <configuration>
+              <artifactItems>
+                <artifactItem>
+                  <groupId>org.eclipse.jetty</groupId>
+                  <artifactId>javadoc</artifactId>
+                  <version>${project.version}</version>
+                  <type>jar</type>
+                </artifactItem>
+              </artifactItems>
+              <outputDirectory>${docs-assembly-directory}/javadoc</outputDirectory>
+            </configuration>
+          </execution>
         </executions>
       </plugin>
       <plugin>
@@ -563,6 +599,19 @@
               <appendAssemblyId>true</appendAssemblyId>
             </configuration>
           </execution>
+          <execution>
+            <id>docs</id>
+            <phase>package</phase>
+            <goals>
+              <goal>single</goal>
+            </goals>
+            <configuration>
+              <descriptors>
+                <descriptor>src/main/assembly/jetty-with-docs-assembly.xml</descriptor>
+              </descriptors>
+              <appendAssemblyId>true</appendAssemblyId>
+            </configuration>
+          </execution>
         </executions>
       </plugin>
     </plugins>
@@ -876,6 +925,14 @@
       <type>jar</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.apache.logging.log4j</groupId>
       <artifactId>log4j-api</artifactId>

diff --git a/jetty-home/src/main/assembly/jetty-with-docs-assembly.xml b/jetty-home/src/main/assembly/jetty-with-docs-assembly.xml
@@ -0,0 +1,46 @@
+<assembly>
+  <id>with-docs</id>
+  <formats>
+    <format>tar.gz</format>
+    <format>zip</format>
+  </formats>
+  <fileSets>
+    <fileSet>
+      <directory>${assembly-directory}</directory>
+      <outputDirectory></outputDirectory>
+      <includes>
+        <include>**</include>
+      </includes>
+      <excludes>
+        <exclude>**/META-INF/**</exclude>
+        <exclude>*-config.jar</exclude>
+        <!-- we'll build up shell scripts with execute in separate file-set -->
+        <exclude>bin/*.sh</exclude>
+      </excludes>
+      <!-- The archive is generated with the uid / gid of the user that
+           built the jetty release.  which is highly unlikely to
+           exist on the target machines that unpack this tarball.
+           We set the user / group / other to have read-only access
+           to files, and read-execute access to directories
+           in the unpacked contents. -->
+      <fileMode>0444</fileMode>
+      <directoryMode>0755</directoryMode>
+    </fileSet>
+    <fileSet>
+      <directory>${assembly-directory}</directory>
+      <outputDirectory></outputDirectory>
+      <includes>
+        <include>bin/*.sh</include>
+      </includes>
+      <!-- Set read-execute for shell scripts -->
+      <fileMode>0555</fileMode>
+    </fileSet>
+    <fileSet>
+      <directory>${docs-assembly-directory}</directory>
+      <outputDirectory></outputDirectory>
+      <includes>
+        <include>**</include>
+      </includes>
+    </fileSet>
+  </fileSets>
+</assembly>
diff --git a/jetty-maven-plugin/pom.xml b/jetty-maven-plugin/pom.xml
@@ -252,14 +252,18 @@
       <artifactId>jetty-slf4j-impl</artifactId>
       <scope>test</scope>
     </dependency>
-    <dependency>
+    <!--<dependency>
       <groupId>org.eclipse.jetty</groupId>
       <artifactId>jetty-home</artifactId>
       <scope>test</scope>
       <type>zip</type>
       <exclusions>
-        <!-- eliminating dependencies of jetty-home that are being pulled in when in reactor
-             for the jetty build itself.  This can cause accidental cyclic references. -->
+        &lt;!&ndash; eliminating dependencies of jetty-home that are being pulled in when in reactor
+             for the jetty build itself.  This can cause accidental cyclic references. &ndash;&gt;
+        <exclusion>
+          <groupId>org.eclipse.jetty</groupId>
+          <artifactId>javadoc</artifactId>
+        </exclusion>
         <exclusion>
           <groupId>org.eclipse.jetty</groupId>
           <artifactId>jetty-alpn-conscrypt-server</artifactId>
@@ -365,7 +369,7 @@
           <artifactId>jboss-logging</artifactId>
         </exclusion>
       </exclusions>
-    </dependency>
+    </dependency>-->
     <dependency>
       <groupId>org.eclipse.jetty.toolchain</groupId>
       <artifactId>jetty-test-helper</artifactId>

diff --git a/pom.xml b/pom.xml
@@ -245,6 +245,7 @@
     <module>documentation</module>
     <module>jetty-keystore</module>
     <module>jetty-unixdomain-server</module>
+    <module>javadoc</module>
   </modules>
 
   <build>
@@ -2206,9 +2207,6 @@
     </profile>
     <profile>
       <id>eclipse-release</id>
-      <modules>
-        <module>javadoc</module>
-      </modules>
       <build>
         <plugins>
           <plugin>