Add script to generate javadoc with JDK17 #19170
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Yanxuan Liu <[email protected]>
pxLi
requested changes
Jun 16, 2025
Signed-off-by: Yanxuan Liu <[email protected]>
Signed-off-by: Yanxuan Liu <[email protected]>
Signed-off-by: Yanxuan Liu <[email protected]>
pxLi
added
improvement
pxLi
reviewed
Jun 19, 2025
java/pom.xml
Outdated
| <artifactId>maven-javadoc-plugin</artifactId> | ||
| <version>3.6.3</version> | ||
| <configuration> | ||
| <classifier>javadoc-jdk17</classifier> |
There was a problem hiding this comment.
I think we were trying to override the default javadoc artifact, so rapids doc can simply use the default artifact for their pages instead of having another *-javadoc-jdk17 one
pxLi
reviewed
Jun 19, 2025
java/pom.xml
Outdated
| @@ -358,6 +358,35 @@ | |||
| </plugins> | |||
| </build> | |||
| </profile> | |||
| <profile> | |||
| <id>javadoc</id> | |||
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new Maven profile to generate javadoc using JDK17 and updates the Docker build script to optionally build the javadoc.
- Added a new in pom.xml for generating javadoc with JDK17.
- Updated java/ci/build-in-docker.sh to install Java 17 and trigger the javadoc build when enabled.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| java/pom.xml | New Maven profile to generate javadoc with JDK17 and custom configuration. |
| java/ci/build-in-docker.sh | Added an option to install Java 17 and generate javadoc using the new profile. |
pxLi
reviewed
Jun 19, 2025
java/ci/build-in-docker.sh
Outdated
| if [ $BUILD_JAVADOC_JDK17 == true ]; then | ||
| yum install -y java-17-openjdk-devel | ||
| export JDK17_HOME=/usr/lib/jvm/java-17-openjdk | ||
| CUDF_INSTALL_DIR="$INSTALL_PREFIX" mvn -B javadoc:jar -P javadoc |
There was a problem hiding this comment.
Q: can we add the profile config directly to BUILD_ARG when $BUILD_JAVADOC_JDK17 == true? we do not require 2 javadoc generation steps
Signed-off-by: Yanxuan Liu <[email protected]>
Signed-off-by: Yanxuan Liu <[email protected]>
Signed-off-by: Yanxuan Liu <[email protected]>
Signed-off-by: Yanxuan Liu <[email protected]>
pxLi
approved these changes
Jun 25, 2025
|
/ok to test f0dd143 |
|
/merge |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Checklist
fix #19062
Need to generate javadoc with JDK17 for search bar.
Created a script to generate javadoc to avoid modifying original pom.xml