From c90aea1344534daa82f93a9abe65a31a74769757 Mon Sep 17 00:00:00 2001
From: Thomas Gran <t2gran@gmail.com>
Date: Tue, 10 Dec 2024 19:15:49 +0100
Subject: [PATCH] feature: Add 'otp-shaded.jar' as an Maven published artifact.

---
 {shaded-jar => otp-shaded}/pom.xml | 87 +++++++++++++++++-------------
 pom.xml                            |  8 ++-
 2 files changed, 55 insertions(+), 40 deletions(-)
 rename {shaded-jar => otp-shaded}/pom.xml (57%)

diff --git a/shaded-jar/pom.xml b/otp-shaded/pom.xml
similarity index 57%
rename from shaded-jar/pom.xml
rename to otp-shaded/pom.xml
index cf48c89271c..1758813b3c5 100644
--- a/shaded-jar/pom.xml
+++ b/otp-shaded/pom.xml
@@ -8,12 +8,10 @@
         <artifactId>otp-root</artifactId>
         <version>2.7.0-SNAPSHOT</version>
     </parent>
-    <artifactId>shaded-jar</artifactId>
-    <packaging>pom</packaging>
+    <artifactId>otp-shaded</artifactId>
     <name>OpenTripPlanner - Shaded Jar</name>
 
     <properties>
-        <maven.source>skip</maven.source>
         <skipShadeJar>false</skipShadeJar>
     </properties>
 
@@ -27,39 +25,25 @@
     </dependencies>
 
     <build>
-        <!-- finalName>otp-${project.version}-shaded</finalName -->
         <plugins>
-            <!--
-             There used to be a dependency-plugin:copy-dependencies plugin entry here, but the
-             shade-plugin will explode the dependencies even if they aren't manually copied in.
-            -->
             <plugin>
-                <!-- We want to create a standalone jar that can be run on the command
-                  line. Java does not really allow this - you cannot place jars inside of jars.
-                  You must either provide all the dependency jars to the user (usually lib/
-                  under the directory containing the runnable jar) or explode all the jars
-                  and repackage them into a single jar. The problem is that while class files
-                  are nicely organized into the package namespace and should not collide, the
-                  META-INF directories of the jars will collide. Maven's standard assembly
-                  plugin does not account for this and will just clobber metadata. This then
-                  causes runtime errors, particularly with Spring. Instead, we use the shade
-                  plugin which has transformers that will for example append files of the same
-                  name rather than overwrite them in the combined JAR. NB: Don't use a version
-                  of the shade plugin older than 1.3.2, as it fixed MSHADE-76 (files not merged
-                  properly if some input files are missing a terminating newline) -->
-                <groupId>org.apache.maven.plugins</groupId>
+                <!--
+                We want to create a standalone jar that can be run on the command line. Java does
+                not really allow this - you cannot place jars inside of jars. You must either
+                provide all the dependency jars to the user (usually lib/ under the directory
+                containing the runnable jar) or explode all the jars and repackage them into a
+                single jar. The problem is that while class files are nicely organized into the
+                package namespace and should not collide, the META-INF directories of the jars will
+                collide. Maven's standard assembly plugin does not account for this and will just
+                clobber metadata. This then causes runtime errors, particularly with Spring.
+                Instead, we use the shade plugin which has transformers that will for example
+                append files of the same name rather than overwrite them in the combined JAR.
+                -->
                 <artifactId>maven-shade-plugin</artifactId>
                 <configuration>
-                    <!--
-                    We need to set the final name for two reasons:
-                      - We want the artifact to have another name than the maven module.
-                        It should be "otp" not "shaded-jar"
-                      - For some odd reason the maven-shade-plugin uses the ${project.packaging}
-                        as the fila extension. So, without it, the file name is
-                        "otp-SNAPSHOT-shaded.pom". Changing the packaging of the project is not
-                        what we want either.
-                    -->
-                    <outputFile>${project.build.directory}/otp-${project.version}-shaded.jar</outputFile>
+                    <skip>${skipShadeJar}</skip>
+                    <shadedArtifactAttached>false</shadedArtifactAttached>
+                    <createDependencyReducedPom>false</createDependencyReducedPom>
                     <filters>
                         <filter>
                             <!-- exclude signatures from merged JAR to avoid invalid signature messages -->
@@ -71,12 +55,6 @@
                             </excludes>
                         </filter>
                     </filters>
-                    <skip>${skipShadeJar}</skip>
-                    <!-- The shaded JAR will not be the main artifact for the project, it will be attached
-                      for deployment in the way source and docs are. -->
-                    <shadedArtifactAttached>true</shadedArtifactAttached>
-                    <!-- shadedClassifierName>shaded</shadedClassifierName -->
-                    <createDependencyReducedPom>false</createDependencyReducedPom>
                     <transformers>
                         <transformer
                                 implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
@@ -107,6 +85,39 @@
                     </execution>
                 </executions>
             </plugin>
+
+
+            <!--
+            DISABLED PLUGINS
+
+
+            Turn off default plugins for package type jar. These plugins will normally run fine
+            even when there is no source, but print warnings in the Maven console log.
+
+            An alternative approach is to set "pom" as package-type and use the
+            build-helper-maven-plugin to attach the shaded jar as the main artifact. This also
+            has side effects. The biggest problem is that the published "pom.xml" does not indicate
+            that the main artifact is a jar file - it has package type pom.
+            -->
+
+            <!--
+            We would like to skip generating an empty jar file, but the maven-shade-plugin
+            fails if we set "skipIfEmpty=true". Not sure if this is a bug or if the
+            maven-shade-plugin needs the generated files/maven meta info from the jar plugin.
+            <plugin>
+                <artifactId>maven-jar-plugin</artifactId>
+                <configuration>
+                    <skipIfEmpty>true</skipIfEmpty>
+                </configuration>
+            </plugin>
+            -->
+            <plugin>
+                <groupId>com.hubspot.maven.plugins</groupId>
+                <artifactId>prettier-maven-plugin</artifactId>
+                <configuration>
+                    <skip>true</skip>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 </project>
diff --git a/pom.xml b/pom.xml
index edc1ab5efd7..b3166900806 100644
--- a/pom.xml
+++ b/pom.xml
@@ -98,7 +98,7 @@
         <module>raptor</module>
         <module>gtfs-realtime-protobuf</module>
         <module>application</module>
-        <module>shaded-jar</module>
+        <module>otp-shaded</module>
     </modules>
 
 
@@ -110,6 +110,11 @@
                     <artifactId>maven-shade-plugin</artifactId>
                     <version>3.6.0</version>
                 </plugin>
+                <plugin>
+                    <groupId>com.hubspot.maven.plugins</groupId>
+                    <artifactId>prettier-maven-plugin</artifactId>
+                    <version>${plugin.prettier.version}</version>
+                </plugin>
             </plugins>
         </pluginManagement>
         <plugins>
@@ -290,7 +295,6 @@
             <plugin>
                 <groupId>com.hubspot.maven.plugins</groupId>
                 <artifactId>prettier-maven-plugin</artifactId>
-                <version>${plugin.prettier.version}</version>
                 <configuration>
                     <skip>${plugin.prettier.skip}</skip>
                     <prettierJavaVersion>2.0.0</prettierJavaVersion>