add automation for cudf-java docs (rapidsai#552)

taureandyernv · Oct 30, 2024 · 47cc727 · 47cc727
1 parent 3239770
commit 47cc727
Show file tree

Hide file tree

Showing 2 changed files with 108 additions and 0 deletions.
diff --git a/.github/workflows/deploy-cudf-java-docs.yaml b/.github/workflows/deploy-cudf-java-docs.yaml
@@ -0,0 +1,66 @@
+name: Deploy cudf-java docs
+
+on:
+  workflow_dispatch:
+    inputs:
+      new_stable_value:
+        description: "New stable value for cudf-java"
+        required: true
+        default: "1"
+      version:
+        description: "Version being released. Format: YY.MM or YY.MM.P e.g 24.08 or 24.08.1"
+        required: true
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash
+
+permissions:
+  id-token: write
+  contents: write
+  pull-requests: write
+
+jobs:
+  deploy-cudf-java-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: ${{ vars.AWS_ROLE_ARN }}
+          aws-region: ${{ vars.AWS_REGION }}
+          role-duration-seconds: 7200 # 2h
+
+      - name: Upload cudf-java docs to S3
+        run: ci/upload_cudf_java_docs.sh ${{ inputs.version }}
+
+      - name: Run script to update stable value for cudf-java in docs.yml
+        env :
+          NEW_STABLE_VALUE: ${{ inputs.new_stable_value }}
+        run: |
+          if [ "$NEW_STABLE_VALUE" != "1" ]; then
+            echo "Invalid value for new_stable_value: $NEW_STABLE_VALUE"
+            exit 1
+          fi
+
+          sed -i '/cudf-java:/,/stable:/s/stable: .*/stable: '"$NEW_STABLE_VALUE"'/' _data/docs.yml
+
+          echo "Updated stable value for cudf-java to $NEW_STABLE_VALUE in _data/docs.yml"
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "Update stable value for cudf-java in docs.yml"
+          branch: "update-stable-value-for-cudf-java"
+          title: Enable cudf-java docs for version ${{ inputs.version }}
+          author: "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>"
+          body: |
+            This PR enables cudf-java docs for version ${{ inputs.version }}.
diff --git a/ci/upload_cudf_java_docs.sh b/ci/upload_cudf_java_docs.sh
@@ -0,0 +1,42 @@
+#!/bin/bash
+# Copyright (c) 2024, NVIDIA CORPORATION.
+
+set -euo pipefail
+
+validate_version() {
+    local version=$1
+    if ! [[ $version =~ ^[0-9]{2}\.[0-9]{2}(\.[0-9]+)?$ ]]; then
+        echo "Error: Version must be in format YY.MM or YY.MM.P" >&2
+        return 1
+    fi
+}
+
+main() {
+    if [ $# -ne 1 ]; then
+        echo "Usage: $0 <version>"
+        echo "Version format: YY.MM or YY.MM.P"
+        echo "Examples: 23.12, 24.02, 23.12.1"
+        exit 1
+    fi
+
+    DOCS_VERSION=$1
+    if ! validate_version "$DOCS_VERSION"; then
+        exit 1
+    fi
+
+    IFS='.' read -r major minor patch <<< "$DOCS_VERSION"
+    patch=${patch:-0} # when no patch is given, use 0
+    patch=$(echo "$patch" | sed 's/^0*//') # strip leading zeros if present
+    patch=${patch:-0} # handle patch values like 00
+
+    local url="https://repo1.maven.org/maven2/ai/rapids/cudf/${major}.${minor}.${patch}/cudf-${major}.${minor}.${patch}-javadoc.jar"
+
+    TMP_FILE=$(mktemp)
+    TMP_DIR=$(mktemp -d)
+    wget -O "${TMP_FILE}" "$url"
+    unzip "${TMP_FILE}" -d "${TMP_DIR}"
+    aws s3 sync --delete "${TMP_DIR}"/ "s3://rapidsai-docs/cudf-java/html/${DOCS_VERSION}/"
+    echo "Documentation successfully uploaded to s3://rapidsai-docs/cudf-java/html/${DOCS_VERSION}/"
+}
+
+main "$@"