Add rapids-upload-docs script (#56)

## Summary This PR adds a new script, `rapids-upload-docs`. The purpose of this script is to consolidate the logic for uploading documentation to S3. This will be useful for the upcoming two efforts: - enabling documentation files to be previewed on PRs - temporarily halting documentation uploads to the `rapidsai-docs` bucket while we restructure the bucket in anticipation of some upcoming website changes ## Usage The snippet below shows how the script can be used. It requires two environment variables be set: - `RAPIDS_VERSION_NUMBER` - a RAPIDS version (e.g. `23.06`) - `RAPIDS_DOCS_DIR` - a path to a directory containing the docs to upload (see folder structure below) ```sh export RAPIDS_VERSION_NUMBER="23.06" export RAPIDS_DOCS_DIR=${RAPIDS_DOCS_DIR:-"${PWD}/documentation"} rapids-logger "Build cuDF Sphinx docs" pushd docs/cudf sphinx-build -b dirhtml source _html sphinx-build -b text source _text mkdir -p "${RAPIDS_DOCS_DIR}/cudf/{html,txt}" mv _html/* "${RAPIDS_DOCS_DIR}/cudf/html" mv _text/* "${RAPIDS_DOCS_DIR}/cudf/txt" popd rapids-logger "Build dask-cuDF Sphinx docs" pushd docs/dask_cudf sphinx-build -b dirhtml source _html sphinx-build -b text source _text mkdir -p "${RAPIDS_DOCS_DIR}/dask-cudf/{html,txt}" mv _html/* "${RAPIDS_DOCS_DIR}/dask-cudf/html" mv _text/* "${RAPIDS_DOCS_DIR}/dask-cudf/txt" popd rapids-upload-docs ``` The structure of `RAPIDS_DOCS_DIR` should look like this: ``` $RAPIDS_DOCS_DIR ├── cudf │ ├── html │ │ └── <html files> │ └── txt │ └── <txt files> └── dask-cudf ├── html │ └── <html files> └── txt └── <txt files> ```
rapidsai · May 30, 2023 · c9fded7 · c9fded7
1 parent 1b18d98
commit c9fded7
Showing 1 changed file with 69 additions and 0 deletions.
diff --git a/tools/rapids-upload-docs b/tools/rapids-upload-docs
@@ -0,0 +1,69 @@
+#!/bin/bash
+set -euo pipefail
+
+checks() {
+  if [[ ! -d "${RAPIDS_DOCS_DIR}" ]]; then
+    echo "ERROR: RAPIDS_DOCS_DIR must be a directory."
+    exit 1
+  fi
+
+  if [[ "${GITHUB_ACTIONS:-false}" != "true" ]]; then
+    echo "Uploading docs from local builds is not supported."
+    exit 0
+  fi
+
+  # TODO: remove this block once pull-request previews are supported
+  if [[ "${RAPIDS_BUILD_TYPE}" == "pull-request" ]]; then
+    echo "Uploading docs for pull-requests is not yet supported."
+    exit 0
+  fi
+}
+
+
+get_s3_dest() {
+  local PROJECT=$1
+  local FORMAT=$2
+
+  case "${RAPIDS_BUILD_TYPE}" in
+    # TODO: double check this path once pull-request previews are supported
+    pull-request)
+      echo -n "$(rapids-s3-path)docs/${PROJECT}/${FORMAT}"
+      return
+      ;;
+    branch|nightly)
+      echo -n "s3://rapidsai-docs/${PROJECT}/${RAPIDS_VERSION_NUMBER}/${FORMAT}"
+      return
+      ;;
+    *)
+      rapids-echo-stderr "please pass a valid RAPIDS_BUILD_TYPE"
+      exit 1
+      ;;
+  esac
+}
+
+copy_docs_to_s3() {
+  local PROJECT_DIR PROJECT PROJECT_FORMAT_DIR FORMAT
+  for PROJECT_DIR in "${RAPIDS_DOCS_DIR}"/*; do
+    PROJECT=$(basename "${PROJECT_DIR}")
+    for PROJECT_FORMAT_DIR in "${PROJECT_DIR}"/*; do
+      FORMAT=$(basename "${PROJECT_FORMAT_DIR}")
+
+      if [[ ! "${FORMAT}" =~ ^(html|txt)$ ]]; then
+        echo "ERROR: FORMAT must be either 'html' or 'txt'."
+        exit 1
+      fi
+
+      rapids-logger "Uploading ${RAPIDS_VERSION_NUMBER} ${PROJECT} ${FORMAT} docs to S3."
+
+      aws s3 sync \
+        --no-progress \
+        --delete \
+        "${PROJECT_FORMAT_DIR}" \
+        "$(get_s3_dest "${PROJECT}" "${FORMAT}")"
+      echo ""
+    done
+  done
+}
+
+checks
+copy_docs_to_s3