Skip to content

Commit

Permalink
chore(build): maven build ERROR/WARNING cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
oldratlee committed Oct 8, 2022
1 parent 6c468b4 commit a1ae57f
Show file tree
Hide file tree
Showing 9 changed files with 90 additions and 146 deletions.
91 changes: 75 additions & 16 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,11 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<!-- overridden by submodule that need skip deploy -->
<maven.deploy.skip>false</maven.deploy.skip>
<javadoc.ttl.base.link>https://alibaba.github.io/transmittable-thread-local/apidocs/${project.version}</javadoc.ttl.base.link>

<spotbugs.annotations.version>4.7.2</spotbugs.annotations.version>
<jsr305.version>3.0.2</jsr305.version>
<jetbrains.annotations.version>23.0.0</jetbrains.annotations.version>

<kotlin.version>1.7.20</kotlin.version>
<kotlin.compiler.jvmTarget>${maven.compiler.source}</kotlin.compiler.jvmTarget>
Expand Down Expand Up @@ -186,14 +189,14 @@
<dependency>
<groupId>com.google.code.findbugs</groupId>
<artifactId>jsr305</artifactId>
<version>3.0.2</version>
<version>${jsr305.version}</version>
<optional>true</optional>
</dependency>
<dependency>
<!-- https://www.jetbrains.com/help/idea/annotating-source-code.html -->
<groupId>org.jetbrains</groupId>
<artifactId>annotations</artifactId>
<version>23.0.0</version>
<version>${jetbrains.annotations.version}</version>
<optional>true</optional>
</dependency>

Expand Down Expand Up @@ -427,6 +430,10 @@
<plugin>
<artifactId>maven-shade-plugin</artifactId>
<version>3.4.0</version>
<configuration>
<shadeSourcesContent>true</shadeSourcesContent>
<dependencyReducedPomLocation>${project.build.directory}/dependency-reduced-pom.xml</dependencyReducedPomLocation>
</configuration>
</plugin>
<plugin>
<artifactId>maven-source-plugin</artifactId>
Expand Down Expand Up @@ -478,11 +485,6 @@
<artifactId>git-commit-id-maven-plugin</artifactId>
<version>5.0.0</version>
</plugin>
<!--
https://spotbugs.github.io/
https://spotbugs.readthedocs.io/en/latest/introduction.html
https://spotbugs.readthedocs.io/en/latest/maven.html
-->
<plugin>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-maven-plugin</artifactId>
Expand Down Expand Up @@ -568,10 +570,37 @@
<javadoc.default.exclude.packages>
*.internal:*.internal.*:*.internal.*.*:*.internal.*.*.*:*.internal.*.*.*.*
</javadoc.default.exclude.packages>
<!--
Apache Maven Javadoc Plugin – Configuring links and offlineLinks Parameters
https://maven.apache.org/plugins/maven-javadoc-plugin/examples/links-configuration.html
more infos about link setting:
Links to JSR 305 in Javadoc are broken https://github.com/google/guava/issues/2479
Fix links to javadoc.io for Maven Javadoc Plugin #2628 https://github.com/google/guava/pull/2628
Can't link to JDK10 in Javadoc comments https://stackoverflow.com/questions/49457896
About package-list vs.element-list
- Can't link to JDK10 in Javadoc comments
https://stackoverflow.com/a/49498219/922688
- Missing javadoc/package-list for release 5.1
https://github.com/gradle/gradle/issues/8183
https://github.com/gradle/gradle/commit/5e88351dd456a5252d21f3a7ad25bff1b62a2fd2
Using the linkoffline Option
https://docs.oracle.com/en/java/javase/11/javadoc/javadoc-command.html#GUID-51213F2C-6E01-4A03-A82A-17428A258A0F
-->
<javadoc.package.list.dir>${maven.multiModuleProjectDirectory}/src/package-list</javadoc.package.list.dir>
<javadoc.extra.offlineLinks>-quiet</javadoc.extra.offlineLinks> <!-- dummy/repeated value, overridden by submodule -->
</properties>
<build>
<plugins>
<plugin>
<!--
https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html
https://docs.oracle.com/en/java/javase/11/javadoc/javadoc-command.html
-->
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<source>8</source>
Expand All @@ -585,17 +614,40 @@
https://stackoverflow.com/questions/39616344
-->
<doclint>all,-missing</doclint>
<overview>src/api/overview.html</overview>
<!-- https://maven.apache.org/plugins/maven-javadoc-plugin/examples/exclude-package-names.html -->
<excludePackageNames>${javadoc.default.exclude.packages}</excludePackageNames>
<additionalJOptions>
<isOffline>true</isOffline>
<!-- https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#detectOfflineLinks -->
<detectOfflineLinks>false</detectOfflineLinks>
<offlineLinks>
<offlineLink>
<url>https://docs.oracle.com/javase/10/docs/api/</url>
<location>${javadoc.package.list.dir}/java/</location>
</offlineLink>
<offlineLink>
<url>https://www.javadoc.io/doc/com.github.spotbugs/spotbugs-annotations/${spotbugs.annotations.version}/</url>
<location>${javadoc.package.list.dir}/spotbugs-annotations/</location>
</offlineLink>
<offlineLink>
<url>https://www.javadoc.io/doc/com.google.code.findbugs/jsr305/${jsr305.version}/</url>
<location>${javadoc.package.list.dir}/jsr305/</location>
</offlineLink>
<offlineLink>
<url>https://www.javadoc.io/doc/org.jetbrains/annotations/${jetbrains.annotations.version}/</url>
<location>${javadoc.package.list.dir}/jetbrains-annotations/</location>
</offlineLink>
</offlineLinks>
<additionalOptions>
<!--
Maven javadoc Search redirects to "/undefined/.." url - Stack Overflow
https://stackoverflow.com/questions/52326318
-->
<additionalJOption>--no-module-directories</additionalJOption>
<additionalOption>--no-module-directories</additionalOption>
<additionalOption>-html5</additionalOption>

<additionalJOption>-html5</additionalJOption>
<additionalOption>${javadoc.extra.offlineLinks}</additionalOption>
</additionalOptions>
<additionalJOptions>
<additionalJOption>-J-Duser.language=en</additionalJOption>
<additionalJOption>-J-Duser.country=US</additionalJOption>
</additionalJOptions>
Expand Down Expand Up @@ -639,16 +691,23 @@
</activation>
<build>
<plugins>
<!--
Spotbugs support @SuppressWarnings
https://github.com/spotbugs/spotbugs/issues/737#issuecomment-416118033
-->
<plugin>
<!--
https://spotbugs.github.io/
https://spotbugs.readthedocs.io/en/latest/introduction.html
https://spotbugs.readthedocs.io/en/latest/maven.html
https://spotbugs.github.io/spotbugs-maven-plugin/check-mojo.html
Binds by default to the lifecycle phase: verify.
Spotbugs support @SuppressWarnings
https://github.com/spotbugs/spotbugs/issues/737#issuecomment-416118033
-->
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-maven-plugin</artifactId>
<executions>
<execution>
<phase>test-compile</phase>
<phase>verify</phase>
<goals>
<goal>check</goal>
</goals>
Expand Down
2 changes: 2 additions & 0 deletions src/package-list/jetbrains-annotations/package-list
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
org.intellij.lang.annotations
org.jetbrains.annotations
3 changes: 3 additions & 0 deletions src/package-list/jsr305/package-list
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
javax.annotation
javax.annotation.concurrent
javax.annotation.meta
42 changes: 4 additions & 38 deletions ttl-agent/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@
</goals>
<configuration>
<relocations>
<!-- https://maven.apache.org/plugins/maven-shade-plugin/examples/class-relocation.html -->
<relocation>
<pattern>javassist</pattern>
<shadedPattern>com.alibaba.ttl3.agent.transformlet.javassist</shadedPattern>
Expand Down Expand Up @@ -141,8 +142,6 @@
</excludes>
</filter>
</filters>
<shadeSourcesContent>true</shadeSourcesContent>
<dependencyReducedPomLocation>${project.build.directory}/dependency-reduced-pom.xml</dependencyReducedPomLocation>
</configuration>
</execution>
</executions>
Expand Down Expand Up @@ -269,42 +268,9 @@
<value>true</value>
</property>
</activation>
<build>
<plugins>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<isOffline>true</isOffline>
<offlineLinks>
<!--
Apache Maven Javadoc Plugin – Configuring links and offlineLinks Parameters
https://maven.apache.org/plugins/maven-javadoc-plugin/examples/links-configuration.html
more infos about link setting:
Links to JSR 305 in Javadoc are broken https://github.com/google/guava/issues/2479
Fix links to javadoc.io for Maven Javadoc Plugin #2628 https://github.com/google/guava/pull/2628
Can't link to JDK10 in Javadoc comments https://stackoverflow.com/questions/49457896
About package-list vs.element-list
- Can't link to JDK10 in Javadoc comments
https://stackoverflow.com/a/49498219/922688
- Missing javadoc/package-list for release 5.1
https://github.com/gradle/gradle/issues/8183
https://github.com/gradle/gradle/commit/5e88351dd456a5252d21f3a7ad25bff1b62a2fd2
-->
<offlineLink>
<url>https://docs.oracle.com/javase/10/docs/api/</url>
<location>${project.basedir}/../src/package-list/java/</location>
</offlineLink>
<offlineLink>
<url>https://static.javadoc.io/com.github.spotbugs/spotbugs-annotations/${spotbugs.annotations.version}/</url>
<location>${project.basedir}/../src/package-list/spotbugs-annotations/</location>
</offlineLink>
</offlineLinks>
</configuration>
</plugin>
</plugins>
</build>
<properties>
<javadoc.extra.offlineLinks>-linkoffline ${javadoc.ttl.base.link}/ttl-core/ ${project.basedir}/../ttl-core/target/apidocs/</javadoc.extra.offlineLinks>
</properties>
</profile>
</profiles>
</project>
48 changes: 0 additions & 48 deletions ttl-core/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -108,52 +108,4 @@
<scope>test</scope>
</dependency>
</dependencies>

<profiles>
<profile>
<id>gen-api-doc</id>
<activation>
<property>
<name>performRelease</name>
<value>true</value>
</property>
</activation>
<build>
<plugins>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<isOffline>true</isOffline>
<offlineLinks>
<!--
Apache Maven Javadoc Plugin – Configuring links and offlineLinks Parameters
https://maven.apache.org/plugins/maven-javadoc-plugin/examples/links-configuration.html
more infos about link setting:
Links to JSR 305 in Javadoc are broken https://github.com/google/guava/issues/2479
Fix links to javadoc.io for Maven Javadoc Plugin #2628 https://github.com/google/guava/pull/2628
Can't link to JDK10 in Javadoc comments https://stackoverflow.com/questions/49457896
About package-list vs.element-list
- Can't link to JDK10 in Javadoc comments
https://stackoverflow.com/a/49498219/922688
- Missing javadoc/package-list for release 5.1
https://github.com/gradle/gradle/issues/8183
https://github.com/gradle/gradle/commit/5e88351dd456a5252d21f3a7ad25bff1b62a2fd2
-->
<offlineLink>
<url>https://docs.oracle.com/javase/10/docs/api/</url>
<location>${project.basedir}/../src/package-list/java/</location>
</offlineLink>
<offlineLink>
<url>https://static.javadoc.io/com.github.spotbugs/spotbugs-annotations/${spotbugs.annotations.version}/</url>
<location>${project.basedir}/../src/package-list/spotbugs-annotations/</location>
</offlineLink>
</offlineLinks>
</configuration>
</plugin>
</plugins>
</build>
</profile>
</profiles>
</project>
File renamed without changes.
21 changes: 6 additions & 15 deletions ttl-integrations/sample-ttl-agent-extension-transformlet/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
<maven.compiler.target>${maven.compiler.source}</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.deploy.skip>true</maven.deploy.skip>
<maven.javadoc.skip>true</maven.javadoc.skip>
<jacoco.skip>true</jacoco.skip>

<ttl.version>3.x-SNAPSHOT</ttl.version>
Expand All @@ -39,23 +40,13 @@
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.2</version>
</plugin>
<plugin>
<artifactId>maven-source-plugin</artifactId>
<version>3.2.1</version>
</plugin>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<source>8</source>
<show>protected</show>
<charset>UTF-8</charset>
<encoding>UTF-8</encoding>
<docencoding>UTF-8</docencoding>
<quiet>true</quiet>
<doclint>all,-missing</doclint>
<!-- https://maven.apache.org/plugins/maven-javadoc-plugin/examples/exclude-package-names.html -->
<excludePackageNames>*.internal:*.internal.*:*.internal.*.*:*.internal.*.*.*:*.internal.*.*.*.*</excludePackageNames>
<additionalJOptions>
<additionalJOption>-J-Duser.language=en</additionalJOption>
<additionalJOption>-J-Duser.country=US</additionalJOption>
</additionalJOptions>
</configuration>
<version>3.4.1</version>
</plugin>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
Expand Down
29 changes: 0 additions & 29 deletions ttl2-compatible/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,6 @@
</excludes>
</filter>
</filters>
<shadeSourcesContent>true</shadeSourcesContent>
<dependencyReducedPomLocation>${project.build.directory}/dependency-reduced-pom.xml</dependencyReducedPomLocation>
</configuration>
</execution>
</executions>
Expand Down Expand Up @@ -316,33 +314,6 @@
<!-- exclude deprecated TtlEnhanced from javadoc -->
<sourceFilesourceFileExclude>com/alibaba/ttl/TtlEnhanced.java</sourceFilesourceFileExclude>
</sourceFileExcludes>
<isOffline>true</isOffline>
<offlineLinks>
<!--
Apache Maven Javadoc Plugin – Configuring links and offlineLinks Parameters
https://maven.apache.org/plugins/maven-javadoc-plugin/examples/links-configuration.html
more infos about link setting:
Links to JSR 305 in Javadoc are broken https://github.com/google/guava/issues/2479
Fix links to javadoc.io for Maven Javadoc Plugin #2628 https://github.com/google/guava/pull/2628
Can't link to JDK10 in Javadoc comments https://stackoverflow.com/questions/49457896
About package-list vs.element-list
- Can't link to JDK10 in Javadoc comments
https://stackoverflow.com/a/49498219/922688
- Missing javadoc/package-list for release 5.1
https://github.com/gradle/gradle/issues/8183
https://github.com/gradle/gradle/commit/5e88351dd456a5252d21f3a7ad25bff1b62a2fd2
-->
<offlineLink>
<url>https://docs.oracle.com/javase/10/docs/api/</url>
<location>${project.basedir}/../src/package-list/java/</location>
</offlineLink>
<offlineLink>
<url>https://static.javadoc.io/com.github.spotbugs/spotbugs-annotations/${spotbugs.annotations.version}/</url>
<location>${project.basedir}/../src/package-list/spotbugs-annotations/</location>
</offlineLink>
</offlineLinks>
</configuration>
</plugin>
</plugins>
Expand Down
File renamed without changes.

0 comments on commit a1ae57f

Please sign in to comment.