GH-537: [Release][Docs] Generate API reference #538
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,21 +17,19 @@ | |
| # specific language governing permissions and limitations | ||
| # under the License. | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| if [[ "${ARROW_JAVA_BUILD:-ON}" != "ON" ]]; then | ||
| exit | ||
| fi | ||
|
|
||
| source_dir=${1} | ||
| build_dir=${2}/java | ||
| java_jni_dist_dir=${3} | ||
|
|
||
| mvn="mvn -B -DskipTests -Drat.skip=true -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn" | ||
|
|
||
| if [ "${ARROW_JAVA_SKIP_GIT_PLUGIN:-OFF}" = "ON" ]; then | ||
| mvn="${mvn} -Dmaven.gitcommitid.skip=true" | ||
| fi | ||
|
|
||
|
|
@@ -61,27 +59,38 @@ done | |
|
|
||
| pushd "${build_dir}" | ||
|
|
||
| # TODO: ARROW_JAVA_SHADE_FLATBUFFERS isn't used for our artifacts. Do | ||
| # we need this? | ||
| # See also: https://github.com/apache/arrow/issues/22021 | ||
| if [ "${ARROW_JAVA_SHADE_FLATBUFFERS:-OFF}" == "ON" ]; then | ||
|
Member
There was a problem hiding this comment. I think we need to revisit this sometime because of #67 (and it appears Google has closed the issue asking them to fix it upstream). AFAIK the discussion in the issue you found is weird...We shouldn't need to change imports ourselves, the shading should take care of that. But that's not relevant here.
Member
Author
There was a problem hiding this comment. OK. Can we use #67 for this topic? Or should we create a separated issue for this topic? |
||
| mvn="${mvn} -Pshade-flatbuffers" | ||
| fi | ||
|
|
||
| if [ "${ARROW_JAVA_CDATA:-OFF}" = "ON" ]; then | ||
| mvn="${mvn} -Darrow.c.jni.dist.dir=${java_jni_dist_dir} -Parrow-c-data" | ||
| fi | ||
|
|
||
| if [ "${ARROW_JAVA_JNI:-OFF}" = "ON" ]; then | ||
| mvn="${mvn} -Darrow.cpp.build.dir=${java_jni_dist_dir} -Parrow-jni" | ||
| fi | ||
|
|
||
| # Use `2 * ncores` threads | ||
| ${mvn} -T 2C clean install | ||
|
|
||
| if [ "${ARROW_JAVA_BUILD_DOCS:-OFF}" == "ON" ]; then | ||
| # HTTP pooling is turned off to avoid download issues: | ||
| # https://github.com/apache/arrow/issues/27496 | ||
| # | ||
| # Maven site plugins not compatible with multithreading: | ||
| # https://github.com/apache/arrow/issues/43378 | ||
| ${mvn} \ | ||
| -Dcheckstyle.skip=true \ | ||
| -Dhttp.keepAlive=false \ | ||
| -Dmaven.wagon.http.pool=false \ | ||
| site | ||
| rm -rf docs/reference | ||
| mkdir -p docs | ||
| cp -a target/site/apidocs/ docs/reference | ||
| fi | ||
|
|
||
| popd | ||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this build the docs for the JNI components too? Or do we need to enable the JNI build to get the Javadocs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No.
Yes. But it's easy because we already have JNI enabled jobs. I'll do it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought we can use
docker compose run vcpkg-jnibut it doesn't create JAR. So I can't use it formvn site.I used
ci/scripts/jni_full_build.shinstead.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, yes, vcpkg-jni only builds the shared object and not the full package