From 2ea646bacdb834c68237ff05d7bb2c5ea81df978 Mon Sep 17 00:00:00 2001
From: Olivier Lamy <oliver.lamy@gmail.com>
Date: Fri, 25 Aug 2023 03:41:17 +1000
Subject: [PATCH] Issue #10312 Remove cyclic dependencies between jetty-home
 and jetty-documentation. Add new module jetty-documentation (#10348)

* cleanup jetty home build extracting jetty-documentation
* Issue #10312 Remove cyclic dependencies between jetty-home and jetty-documentation

Signed-off-by: Olivier Lamy <olamy@apache.org>
Signed-off-by: Joakim Erdfelt <joakim.erdfelt@gmail.com>
Co-authored-by: Joakim Erdfelt <joakim.erdfelt@gmail.com>
---
 .../jetty/docs/JettyIncludeExtension.java     |  3 +-
 documentation/jetty-documentation/pom.xml     | 31 ++++++++++
 jetty-home/pom.xml                            | 60 -------------------
 .../assembly/jetty-with-docs-assembly.xml     | 46 --------------
 .../src/main/assembly/site-component.xml      | 18 ------
 5 files changed, 33 insertions(+), 125 deletions(-)
 delete mode 100644 jetty-home/src/main/assembly/jetty-with-docs-assembly.xml
 delete mode 100644 jetty-home/src/main/assembly/site-component.xml

diff --git a/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/JettyIncludeExtension.java b/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/JettyIncludeExtension.java
index 86f03539332..35d7abb9d16 100644
--- a/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/JettyIncludeExtension.java
+++ b/documentation/jetty-asciidoctor-extensions/src/main/java/org/eclipse/jetty/docs/JettyIncludeExtension.java
@@ -89,9 +89,10 @@ public class JettyIncludeExtension implements ExtensionRegistry
         {
             try
             {
+                String jettyVersion = (String)document.getAttribute("project-version");
                 // Document attributes are converted by Asciidoctor to lowercase.
                 Path jettyDocsPath = Path.of((String)document.getAttribute("project-basedir"));
-                Path jettyHome = jettyDocsPath.resolve("../../jetty-home/target/jetty-home").normalize();
+                Path jettyHome = jettyDocsPath.resolve("target/jetty-home-" + jettyVersion).normalize();
 
                 JettyHomeTester jetty = JettyHomeTester.Builder.newInstance()
                     .jettyHome(jettyHome)
diff --git a/documentation/jetty-documentation/pom.xml b/documentation/jetty-documentation/pom.xml
index d292b87b42c..8a3c1fa7b2d 100644
--- a/documentation/jetty-documentation/pom.xml
+++ b/documentation/jetty-documentation/pom.xml
@@ -138,6 +138,30 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-dependency-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>unpack-jetty-home</id>
+            <phase>generate-resources</phase>
+            <goals>
+              <goal>unpack</goal>
+            </goals>
+            <configuration>
+              <artifactItems>
+                <artifactItem>
+                  <groupId>org.eclipse.jetty</groupId>
+                  <artifactId>jetty-home</artifactId>
+                  <version>${project.version}</version>
+                  <type>zip</type>
+                </artifactItem>
+              </artifactItems>
+              <outputDirectory>${project.build.directory}/</outputDirectory>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
       <plugin>
         <artifactId>maven-assembly-plugin</artifactId>
         <configuration>
@@ -248,5 +272,12 @@
       <groupId>org.eclipse.jetty.websocket</groupId>
       <artifactId>websocket-jetty-server</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.eclipse.jetty</groupId>
+      <artifactId>jetty-home</artifactId>
+      <version>${project.version}</version>
+      <type>zip</type>
+      <optional>true</optional>
+    </dependency>
   </dependencies>
 </project>
diff --git a/jetty-home/pom.xml b/jetty-home/pom.xml
index 36dab5011f6..02eb5c01185 100644
--- a/jetty-home/pom.xml
+++ b/jetty-home/pom.xml
@@ -13,7 +13,6 @@
   <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>
@@ -509,44 +508,6 @@
               <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>
-                  <classifier>html</classifier>
-                  <type>zip</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>
-                  <classifier>javadoc</classifier>
-                  <type>jar</type>
-                </artifactItem>
-              </artifactItems>
-              <outputDirectory>${docs-assembly-directory}/javadoc</outputDirectory>
-            </configuration>
-          </execution>
         </executions>
       </plugin>
       <plugin>
@@ -602,19 +563,6 @@
               <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>
@@ -928,14 +876,6 @@
       <type>jar</type>
       <optional>true</optional>
     </dependency>
-    <dependency>
-      <groupId>org.eclipse.jetty.documentation</groupId>
-      <artifactId>jetty-documentation</artifactId>
-      <version>${project.version}</version>
-      <classifier>html</classifier>
-      <type>zip</type>
-      <optional>true</optional>
-    </dependency>
     <dependency>
       <groupId>org.eclipse.jetty</groupId>
       <artifactId>javadoc</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
deleted file mode 100644
index c38740b3427..00000000000
--- a/jetty-home/src/main/assembly/jetty-with-docs-assembly.xml
+++ /dev/null
@@ -1,46 +0,0 @@
-<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-home/src/main/assembly/site-component.xml b/jetty-home/src/main/assembly/site-component.xml
deleted file mode 100644
index 694addb43a2..00000000000
--- a/jetty-home/src/main/assembly/site-component.xml
+++ /dev/null
@@ -1,18 +0,0 @@
-<assembly>
-  <id>site-component</id>
-  <formats>
-    <format>jar</format>
-  </formats>
-  <fileSets>
-    <fileSet>
-      <directory>${basedir}/target/dist-src</directory>
-      <outputDirectory>jetty-home-${version}-site-component</outputDirectory>
-      <includes>
-        <include>target/site/**</include>
-        <include>README**</include>
-        <include>VERSION**</include>
-        <include>LICENSES/**</include>
-      </includes>
-    </fileSet>
-  </fileSets>
-</assembly>
\ No newline at end of file