From 622ebf3c5b46bc7105877619e8102dc496a79785 Mon Sep 17 00:00:00 2001
From: Martin Stockhammer <martin_s@apache.org>
Date: Sun, 28 Jun 2020 10:52:30 +0200
Subject: [PATCH] Adding comments to pom files for documentation

---
 .../oak-jcr/metadata-store-jcr/pom.xml        |  2 +-
 .../oak-jcr/oak-jcr-lucene/pom.xml            | 37 ++++++++++++++++---
 pom.xml                                       |  4 ++
 3 files changed, 37 insertions(+), 6 deletions(-)

diff --git a/archiva-modules/metadata/metadata-store-provider/oak-jcr/metadata-store-jcr/pom.xml b/archiva-modules/metadata/metadata-store-provider/oak-jcr/metadata-store-jcr/pom.xml
index b764a33aa..26a94f3ab 100644
--- a/archiva-modules/metadata/metadata-store-provider/oak-jcr/metadata-store-jcr/pom.xml
+++ b/archiva-modules/metadata/metadata-store-provider/oak-jcr/metadata-store-jcr/pom.xml
@@ -26,7 +26,7 @@
     <version>3.0.0-SNAPSHOT</version>
   </parent>
   <artifactId>metadata-store-jcr</artifactId>
-  <name>Archiva Metadata :: Store Provider :: JCR :: OAK</name>
+  <name>Archiva Metadata :: Store Provider :: JCR :: Oak Implementation</name>
   <description>Metadata provider that uses JCR Oak as backend</description>
 
   <properties>
diff --git a/archiva-modules/metadata/metadata-store-provider/oak-jcr/oak-jcr-lucene/pom.xml b/archiva-modules/metadata/metadata-store-provider/oak-jcr/oak-jcr-lucene/pom.xml
index 7b96010f0..067be3eda 100644
--- a/archiva-modules/metadata/metadata-store-provider/oak-jcr/oak-jcr-lucene/pom.xml
+++ b/archiva-modules/metadata/metadata-store-provider/oak-jcr/oak-jcr-lucene/pom.xml
@@ -31,12 +31,23 @@
   <name>Archiva Metadata :: Store Provider :: JCR :: Shaded OAK Lucene</name>
   <description>This module shades the lucene dependencies of jcr oak to avoid version conflicts</description>
 
+  <!--
+    You may have to update this file, if the JCR OAK dependency version changes in archiva:
+    - Check, if the lucene classes are still part of the JAR file
+    - Check the resulting jar file for any unshaded lucene packages
+    - Check the dependency by mvn dependency:tree for added / removed transitive dependencies
+    - Check the resulting LICENSE/LICENSE.txt and NOTICE/NOTICE.txt for changes.
+    -->
+
   <dependencies>
     <dependency>
       <groupId>org.apache.jackrabbit</groupId>
       <artifactId>oak-lucene</artifactId>
       <version>${jcr-oak.version}</version>
-      <!-- Lucene classes are included already in the oak-lucene.jar, so we exclude this dependency -->
+      <!-- Lucene classes are included already in the oak-lucene.jar, so we exclude this dependencies
+           Not sure, if it is the intention of JCR OAK team to provide some kind of uber jar with oak-lucene,
+           but that's what it is. We use the classes in the JAR file for shading, not the dependencies.
+           Must be checked after each version upgrade of OAK JCR -->
       <exclusions>
         <exclusion>
           <groupId>org.apache.lucene</groupId>
@@ -119,7 +130,24 @@
             </excludes>
           </configuration>
         </plugin>
+
+        <!-- We don't have code in this package, only do some repackaging so we skip the LICENSE -->
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-remote-resources-plugin</artifactId>
+          <executions>
+            <execution>
+              <goals>
+                <goal>process</goal>
+              </goals>
+              <configuration>
+                <skip>true</skip>
+              </configuration>
+            </execution>
+          </executions>
+        </plugin>
       </plugins>
+
     </pluginManagement>
 
     <plugins>
@@ -162,11 +190,7 @@
                 <filter>
                   <artifact>*:*</artifact>
                   <excludes>
-                    <exclude>META-INF/NOTICE</exclude>
-                    <exclude>META-INF/NOTICE.TXT</exclude>
-                    <exclude>META-INF/NOTICE.txt</exclude>
                     <exclude>META-INF/MANIFEST.MF</exclude>
-                    <exclude>LICENSE.TXT</exclude>
                   </excludes>
                 </filter>
               </filters>
@@ -210,6 +234,9 @@
               </relocations>
               <transformers>
                 <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer">
+                  <addHeader>false</addHeader>
+                </transformer>
               </transformers>
             </configuration>
           </execution>
diff --git a/pom.xml b/pom.xml
index 2ff3d2acb..a6bea8de8 100644
--- a/pom.xml
+++ b/pom.xml
@@ -72,7 +72,11 @@
 
     <!-- JCR modules -->
     <javax.jcr.version>2.0</javax.jcr.version>
+    <!-- If you change the JCR OAK version, you may have to update the pom.xml in the module oak-jcr-lucene
+         to adapt to dependency changes -->
     <jcr-oak.version>1.22.3</jcr-oak.version>
+
+
     <!-- Jackrabbit classes are still used for webdav -->
     <jackrabbit.version>2.15.4</jackrabbit.version>
     <metrics-core.version>3.1.0</metrics-core.version>