Skip to content

Add script to generate javadoc with JDK17 #19170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jun 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions java/ci/build-in-docker.sh
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ ENABLE_NVTX=${ENABLE_NVTX:-ON}
ENABLE_GDS=${ENABLE_GDS:-OFF}
OUT=${OUT:-out}
CMAKE_GENERATOR=${CMAKE_GENERATOR:-Ninja}
BUILD_JAVADOC_JDK17=${BUILD_JAVADOC_JDK17:-false}

SIGN_FILE=$1
#Set absolute path for OUT_PATH
Expand Down Expand Up @@ -92,6 +93,13 @@ if [ "$SIGN_FILE" == true ]; then
BUILD_ARG+=("-Prelease")
fi

# Generate javadoc with JDK 17
if [ $BUILD_JAVADOC_JDK17 == true ]; then
yum install -y java-17-openjdk-devel
export JDK17_HOME=/usr/lib/jvm/java-17-openjdk
BUILD_ARG+=("-Pjavadoc-jdk17")
fi

if [ -f "$WORKSPACE/java/ci/settings.xml" ]; then
# Build with an internal settings.xml
BUILD_ARG+=("-s" "$WORKSPACE/java/ci/settings.xml")
Expand Down
29 changes: 29 additions & 0 deletions java/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,35 @@
</plugins>
</build>
</profile>
<profile>
<id>javadoc-jdk17</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.6.3</version>
<configuration>
<classifier>javadoc</classifier>
<additionalJOptions>
<additionalJOption>-Xdoclint:none</additionalJOption>
</additionalJOptions>
<source>8</source> <!-- Compatible to JDK 8 -->
<!-- Set JDK 17 javadoc path -->
<javadocExecutable>${env.JDK17_HOME}/bin/javadoc</javadocExecutable>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>

<build>
Expand Down