[java-parent-project] branch master updated: JPAR-164 and JPAR-163 - Use patched maven javadoc plugin

Phil Smart philip.smart at jisc.ac.uk
Wed Apr 22 05:32:02 EDT 2020


This is an automated email from the git hooks/post-receive script.

philsmart pushed a commit to branch master
in repository java-parent-project.

View the commit online:
http://git.shibboleth.net/view/?p=java-parent-project.git;a=commit;h=de0479a5b9e6c704075426b71195ec3f39cbc468

The following commit(s) were added to refs/heads/master by this push:
       new  de0479a   JPAR-164 and JPAR-163 - Use patched maven javadoc plugin
de0479a is described below

commit de0479a5b9e6c704075426b71195ec3f39cbc468
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Tue Apr 21 16:56:05 2020 +0100

    JPAR-164 and JPAR-163 - Use patched maven javadoc plugin
    
    - JPAR-164 - Add the git patch of Maven Javadoc Plugin
                 3.2.0 to the parent project
    - JPAR-163 - Set maven compiler release version to 11
    
    https://issues.shibboleth.net/jira/browse/JPAR-164
    https://issues.shibboleth.net/jira/browse/JPAR-163
---
 pom.xml                                            |  16 ++-
 ...-165-Add-Maven-Javadoc-Plugin-3.2.0-patch.patch | 115 +++++++++++++++++++++
 2 files changed, 127 insertions(+), 4 deletions(-)

diff --git a/pom.xml b/pom.xml
index 2311357..71f88c0 100644
--- a/pom.xml
+++ b/pom.xml
@@ -16,8 +16,7 @@
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <maven.compiler.source>11</maven.compiler.source>
-        <maven.compiler.target>11</maven.compiler.target>
+        <maven.compiler.release>11</maven.compiler.release>
 
         <bouncycastle.version>1.64</bouncycastle.version>
         <cryptacular.version>1.2.4</cryptacular.version>
@@ -62,7 +61,7 @@
         <maven-enforcer-plugin.version>3.0.0-M3</maven-enforcer-plugin.version>
         <maven-install-plugin.version>3.0.0-M1</maven-install-plugin.version>
         <maven-jar-plugin.version>3.2.0</maven-jar-plugin.version>
-        <maven-javadoc-plugin.version>3.1.1</maven-javadoc-plugin.version>
+        <maven-javadoc-plugin.version>3.2.0</maven-javadoc-plugin.version>
         <maven-jxr-plugin.version>3.0.0</maven-jxr-plugin.version>
         <maven-project-info-reports-plugin.version>3.0.0</maven-project-info-reports-plugin.version>
         <maven-resources-plugin.version>3.1.0</maven-resources-plugin.version>
@@ -686,12 +685,20 @@
                     <artifactId>maven-jar-plugin</artifactId>
                     <version>${maven-jar-plugin.version}</version>
                 </plugin>
+                <!--
+                    Patched version of this plugin, see:
+
+                    https://issues.shibboleth.net/jira/browse/JPAR-164
+
+                    Possibly replace with official version post 3.2.0
+                -->
                 <plugin>
-                    <groupId>org.apache.maven.plugins</groupId>
+                    <groupId>net.shibboleth.maven.plugins</groupId>
                     <artifactId>maven-javadoc-plugin</artifactId>
                     <version>${maven-javadoc-plugin.version}</version>
                     <configuration>
                         <links>
+                            <!-- The Java SE link is possibly not used (see JPAR-163) -->
                             <link>${javase.link}</link>
                             <link>${spring-framework.link}</link>
                             <link>${spring-webflow.link}</link>
@@ -870,6 +877,7 @@
                 <version>${maven-javadoc-plugin.version}</version>
                 <configuration>
                     <links>
+                        <!-- The Java SE link is possibly not used (see JPAR-163) -->
                         <link>${javase.link}</link>
                         <link>${spring-framework.link}</link>
                         <link>${spring-webflow.link}</link>
diff --git a/resources/maven/JPAR-165-Add-Maven-Javadoc-Plugin-3.2.0-patch.patch b/resources/maven/JPAR-165-Add-Maven-Javadoc-Plugin-3.2.0-patch.patch
new file mode 100644
index 0000000..d0ca921
--- /dev/null
+++ b/resources/maven/JPAR-165-Add-Maven-Javadoc-Plugin-3.2.0-patch.patch
@@ -0,0 +1,115 @@
+From 057b3ec1ae328d249638a0be205ba9314a90d3d8 Mon Sep 17 00:00:00 2001
+From: Phil Smart <philip.smart at jisc.ac.uk>
+Date: Thu, 9 Apr 2020 16:50:49 +0100
+Subject: [PATCH 1/2] JPAR-165 Add Maven Javadoc Plugin 3.2.0 patch
+
+Patch the modulesForAggregatedProject to normalise module
+file paths.
+
+https://issues.shibboleth.net/jira/browse/JPAR-165
+---
+ .../org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java   | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
+index 83c3bd0..44d4fd8 100644
+--- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
++++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
+@@ -2405,7 +2405,7 @@ public abstract class AbstractJavadocMojo
+         List<Path> modulePaths = new LinkedList<>();
+         for ( String module :  aggregatedProject.getModules() )
+         {
+-            modulePaths.add( new File( aggregatedProject.getBasedir(), module ).toPath() );
++            modulePaths.add( new File( aggregatedProject.getBasedir(), module ).toPath().normalize() );
+         }
+ 
+         Set<MavenProject> aggregatedModules = new LinkedHashSet<>();
+-- 
+2.21.0 (Apple Git-122.2)
+
+
+From 10bd31d76d020a2fa206e106fb9bb59c1183690b Mon Sep 17 00:00:00 2001
+From: Phil Smart <philip.smart at jisc.ac.uk>
+Date: Thu, 16 Apr 2020 16:56:05 +0100
+Subject: [PATCH 2/2] JPAR-165 Add Maven Javadoc Plugin 3.2.0 patch
+
+ - Add log statement to the start of plugin execution
+ - Change POM for internal project use
+
+https://issues.shibboleth.net/jira/browse/JPAR-165
+---
+ pom.xml                                       | 31 +++++++------------
+ .../plugins/javadoc/AbstractJavadocMojo.java  |  1 +
+ 2 files changed, 12 insertions(+), 20 deletions(-)
+
+diff --git a/pom.xml b/pom.xml
+index 465e4ae..dff54fa 100644
+--- a/pom.xml
++++ b/pom.xml
+@@ -29,13 +29,14 @@ under the License.
+     <relativePath />
+   </parent>
+ 
++  <groupId>net.shibboleth.maven.plugins</groupId>
+   <artifactId>maven-javadoc-plugin</artifactId>
+   <version>3.2.0</version>
+   <packaging>maven-plugin</packaging>
+ 
+   <name>Apache Maven Javadoc Plugin</name>
+   <description>
+-    The Apache Maven Javadoc Plugin is a plugin that uses the javadoc tool for
++    Patched version of The Apache Maven Javadoc Plugin which supports flat maven mulit-module projects. The Apache Maven Javadoc Plugin is a plugin that uses the javadoc tool for
+     generating javadocs for the specified project.
+   </description>
+   <inceptionYear>2004</inceptionYear>
+@@ -44,26 +45,16 @@ under the License.
+     <maven>${mavenVersion}</maven>
+   </prerequisites>
+ 
+-  <scm>
+-    <connection>scm:git:https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git</connection>
+-    <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git</developerConnection>
+-    <url>https://github.com/apache/maven-javadoc-plugin/tree/${project.scm.tag}</url>
+-    <tag>maven-javadoc-plugin-3.2.0</tag>
+-  </scm>
+-  <issueManagement>
+-    <system>jira</system>
+-    <url>https://issues.apache.org/jira/browse/MJAVADOC</url>
+-  </issueManagement>
+-  <ciManagement>
+-    <system>Jenkins</system>
+-    <url>https://builds.apache.org/job/maven-box/job/maven-javadoc-plugin/</url>
+-  </ciManagement>
+   <distributionManagement>
+-    <site>
+-      <id>apache.website</id>
+-      <url>scm:svn:https://svn.apache.org/repos/asf/maven/website/components/${maven.site.path}</url>
+-    </site>
+-  </distributionManagement>
++        <repository>
++            <id>release</id>
++            <url>https://build.shibboleth.net/nexus/content/repositories/releases</url>
++        </repository>
++        <snapshotRepository>
++            <id>snapshot</id>
++            <url>https://build.shibboleth.net/nexus/content/repositories/snapshots</url>
++        </snapshotRepository>
++    </distributionManagement>
+ 
+   <properties>
+     <javaVersion>7</javaVersion>
+diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
+index 44d4fd8..df07e47 100644
+--- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
++++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
+@@ -5801,6 +5801,7 @@ public abstract class AbstractJavadocMojo
+     private void doExecuteJavadocCommandLine( Commandline cmd, File javadocOutputDirectory )
+         throws MavenReportException
+     {
++        getLog().info( "Running patched (for flat multi-module projects) maven javadoc plugin" );
+         if ( getLog().isDebugEnabled() )
+         {
+             // no quoted arguments
+-- 
+2.21.0 (Apple Git-122.2)
+

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.


More information about the commits mailing list