From: Alexander Kriegisch <Alexander@Kriegisch.name>
Date: Sat, 17 Feb 2024 04:37:08 +0000 (+0700)
Subject: Use Antrun plugin to eliminate javadoc version number in HTML
X-Git-Tag: V1_9_21_2~31
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=09aa15b528e94cd1f21c9d783460bc0e23e0800f;p=aspectj.git

Use Antrun plugin to eliminate javadoc version number in HTML

This is the one issue that cannot be solved regarding reproducible
builds by setting javadoc options, because that header comment is
hard-coded into the JDK with no option to avoid it. I just created an
OpenJDK issue (internal review ID 9076583, not published yet) for it,
but that does not help us today.

Signed-off-by: Alexander Kriegisch <Alexander@Kriegisch.name>
---

diff --git a/aspectjmatcher/pom.xml b/aspectjmatcher/pom.xml
index ee20f307c..1c56f1210 100644
--- a/aspectjmatcher/pom.xml
+++ b/aspectjmatcher/pom.xml
@@ -199,6 +199,19 @@
 				</executions>
 			</plugin>
 
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-antrun-plugin</artifactId>
+				<executions>
+					<!-- Remove javadoc version number from HTML comment to keep website diffs small -->
+					<execution>
+						<id>filter-javadocs</id>
+						<!-- Override default phase 'none' from parent -->
+						<phase>package</phase>
+					</execution>
+				</executions>
+			</plugin>
+
 			<!-- Caveat: Attaching the flattened POM needs packaging=jar, so do not use packaging=pom for this module -->
 			<plugin>
 				<groupId>org.codehaus.mojo</groupId>
diff --git a/aspectjrt/pom.xml b/aspectjrt/pom.xml
index 4377c3e76..be1bc7059 100644
--- a/aspectjrt/pom.xml
+++ b/aspectjrt/pom.xml
@@ -197,6 +197,19 @@
 				</executions>
 			</plugin>
 
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-antrun-plugin</artifactId>
+				<executions>
+					<!-- Remove javadoc version number from HTML comment to keep website diffs small -->
+					<execution>
+						<id>filter-javadocs</id>
+						<!-- Override default phase 'none' from parent -->
+						<phase>package</phase>
+					</execution>
+				</executions>
+			</plugin>
+
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-resources-plugin</artifactId>
diff --git a/aspectjtools/pom.xml b/aspectjtools/pom.xml
index 5df90da85..a872b1ea7 100644
--- a/aspectjtools/pom.xml
+++ b/aspectjtools/pom.xml
@@ -271,6 +271,19 @@
 				</executions>
 			</plugin>
 
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-antrun-plugin</artifactId>
+				<executions>
+					<!-- Remove javadoc version number from HTML comment to keep website diffs small -->
+					<execution>
+						<id>filter-javadocs</id>
+						<!-- Override default phase 'none' from parent -->
+						<phase>package</phase>
+					</execution>
+				</executions>
+			</plugin>
+
 			<!-- Caveat: Attaching the flattened POM needs packaging=jar, so do not use packaging=pom for this module -->
 			<plugin>
 				<groupId>org.codehaus.mojo</groupId>
diff --git a/aspectjweaver/pom.xml b/aspectjweaver/pom.xml
index b8ad8cd24..964821255 100644
--- a/aspectjweaver/pom.xml
+++ b/aspectjweaver/pom.xml
@@ -272,6 +272,19 @@
 				</executions>
 			</plugin>
 
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-antrun-plugin</artifactId>
+				<executions>
+					<!-- Remove javadoc version number from HTML comment to keep website diffs small -->
+					<execution>
+						<id>filter-javadocs</id>
+						<!-- Override default phase 'none' from parent -->
+						<phase>package</phase>
+					</execution>
+				</executions>
+			</plugin>
+
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-resources-plugin</artifactId>
diff --git a/pom.xml b/pom.xml
index 8855eee7a..8e0afc598 100644
--- a/pom.xml
+++ b/pom.xml
@@ -465,6 +465,45 @@
 						<windowtitle>${project.name} API</windowtitle>
 					</configuration>
 				</plugin>
+				<plugin>
+					<groupId>org.apache.maven.plugins</groupId>
+					<artifactId>maven-antrun-plugin</artifactId>
+					<version>3.1.0</version>
+					<executions>
+						<!--
+							Remove javadoc version number from HTML comment to keep website diffs small.
+
+							Attention: This has no effect on javadocs generated by the 'jar' goal, because they are archived while
+							Maven Javadoc runs, i.e. before this plugin execution kicks in. However, it cleans the javadocs before
+							Maven Resources copies them to aj-build/dist/docs/doc. I.e., they will be clean on the website, if copied
+							from that folder, and also in the installer.
+
+							TODO: In the future, maybe this execution or the whole Antrun plugin can go away, after a JDK feature
+							  request I just created (internal review ID 9076583) has been implemented and back-ported into all JDK
+							  versions we support for javadoc generation. But if that ever happens, it might take a while.
+						-->
+						<execution>
+							<id>filter-javadocs</id>
+							<!-- Override phase to 'package' in modules which need to filter javadocs -->
+							<phase>none</phase>
+							<goals>
+								<goal>run</goal>
+							</goals>
+							<configuration>
+								<target>
+									<!-- See https://ant.apache.org/manual/Tasks/replaceregexp.html -->
+									<replaceregexp byline="true">
+										<regexp pattern="^(&lt;!-- Generated by javadoc ).* (--&gt;)$"/>
+										<substitution expression="\1\2"/>
+										<fileset dir="${project.build.directory}/apidocs">
+											<include name="**/*.html"/>
+										</fileset>
+									</replaceregexp>
+								</target>
+							</configuration>
+						</execution>
+					</executions>
+				</plugin>
 				<plugin>
 					<groupId>org.asciidoctor</groupId>
 					<artifactId>asciidoctor-maven-plugin</artifactId>