panbingkun commented on code in PR #48860: URL: https://github.com/apache/spark/pull/48860#discussion_r1860439413
########## dev/spark-test-image-util/docs/build-docs: ########## @@ -0,0 +1,71 @@ +#!/usr/bin/env bash + +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +if ! [ -x "$(command -v docker)" ]; then + echo "Error: Docker is not installed." >&2 + exit 1 +fi + +DOCKER_CACHE_IMG="ghcr.io/apache/spark/apache-spark-github-action-image-docs-cache:master" +REPO_OWNER="apache/spark" +REPOSITORY="apache-spark-ci-image-docs" +IMG_TAG=$(date +%s) +IMG_NAME="${REPOSITORY}:${IMG_TAG}" +IMG_URL="$REPO_OWNER/$IMG_NAME" +DOCKER_MOUNT_SPARK_HOME="/__w/spark/spark" +BUILD_DOCS_SCRIPT_PATH="${DOCKER_MOUNT_SPARK_HOME}/dev/spark-test-image-util/docs/run-in-container" + +FWDIR="$(cd "`dirname "${BASH_SOURCE[0]}"`"; pwd)" +SPARK_HOME="$(cd "`dirname "${BASH_SOURCE[0]}"`"/../../..; pwd)" + +# 1.Compile spark outside the container to prepare for generating documents inside the container. +build/sbt -Phive -Pkinesis-asl clean unidoc package + +# 2.Build container image. +docker buildx build \ + --cache-from type=registry,ref="${DOCKER_CACHE_IMG}" \ + --tag "${IMG_URL}" "${FWDIR}" \ + --file "${SPARK_HOME}/dev/spark-test-image/docs/Dockerfile" + +# 3.Build docs on container: `error docs`, `scala doc`, `python doc`, `sql doc`. +docker run \ + --mount type=bind,source="${SPARK_HOME}",target="${DOCKER_MOUNT_SPARK_HOME}" \ + --interactive --tty "${IMG_URL}" \ + /bin/bash -c "sh ${BUILD_DOCS_SCRIPT_PATH}" + +# 4.Build docs on host: `r doc`. Review Comment: There is a difference, we do not want to run `sbt compile` in the `containe`r because there is no `ivy cache` in the container. when executing it, `all dependent jars` will be downloaded. If we use a similar mounting workaround, the complexity will increase significantly. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
