From 1d255d3278d288feab34f7557122a30d7ae5b0fc Mon Sep 17 00:00:00 2001
From: Stan Brubaker <120737309+stanbrub@users.noreply.github.com>
Date: Mon, 11 Dec 2023 12:23:12 -0700
Subject: [PATCH] Docs CI Rework for Versioned Deploy (#4904)

Added new directory (deephaven-core-v2) for versioned api docs.
---
 .github/workflows/docs-ci-v2.yml | 378 +++++++++++++++++++++++++++++++
 1 file changed, 378 insertions(+)
 create mode 100644 .github/workflows/docs-ci-v2.yml

diff --git a/.github/workflows/docs-ci-v2.yml b/.github/workflows/docs-ci-v2.yml
new file mode 100644
index 00000000000..66a480ee677
--- /dev/null
+++ b/.github/workflows/docs-ci-v2.yml
@@ -0,0 +1,378 @@
+name: Docs CI V2
+
+on:
+  pull_request:
+    branches: [ main ]
+  push:
+    branches: [ 'main', 'release/v*' ]
+
+jobs:
+  symlink:
+    if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/heads/release/v') }}
+    needs: [javadoc, typedoc, pydoc, cppdoc, rdoc]
+    runs-on: ubuntu-22.04
+    concurrency:
+      group: symlink-${{ github.workflow }}-${{ github.ref }}
+      # We don't want to cancel in-progress jobs against main because that might leave the upload in a bad state.
+      cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Make Symlinks
+        run: |
+          mkdir -p tmp-deephaven-core-v2/symlinks;
+          cd tmp-deephaven-core-v2/symlinks
+          ln -s ../${{ github.ref_name }} latest
+          ln -s ../main next
+          
+      - name: Deploy Symlinks
+        uses: burnett01/rsync-deployments@5.2
+        with:
+          switches: -rlptDvz
+          path: tmp-deephaven-core-v2/
+          remote_path: deephaven-core-v2/
+          remote_host: ${{ secrets.DOCS_HOST }}
+          remote_port: ${{ secrets.DOCS_PORT }}
+          remote_user: ${{ secrets.DOCS_USER }}
+          remote_key: ${{ secrets.DEEPHAVEN_CORE_SSH_KEY }}
+  javadoc:
+    runs-on: ubuntu-22.04
+    concurrency:
+      group: javadoc-${{ github.workflow }}-${{ github.ref }}
+      # We don't want to cancel in-progress jobs against main because that might leave the upload in a bad state.
+      cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup JDK 11
+        id: setup-java-11
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '11'
+
+      - name: Setup JDK 17
+        id: setup-java-17
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - name: Set JAVA_HOME
+        run: echo "JAVA_HOME=${{ steps.setup-java-11.outputs.path }}" >> $GITHUB_ENV
+
+      - name: Setup gradle properties
+        run: |
+          .github/scripts/gradle-properties.sh >> gradle.properties
+          cat gradle.properties
+
+      - name: All Javadoc
+        uses: burrunan/gradle-cache-action@v1
+        with:
+          job-id: allJavadoc
+          arguments: --scan outputVersion combined-javadoc:allJavadoc
+          gradle-version: wrapper
+          
+      - name: Get Deephaven Version
+        id: dhc-version
+        run: echo "version=$(cat build/version)" >> $GITHUB_OUTPUT
+
+      - name: Upload Javadocs
+        if: ${{ github.event_name == 'push' }} 
+        uses: actions/upload-artifact@v3
+        with:
+          name: javadocs-${{ steps.dhc-version.outputs.version }}
+          path: 'combined-javadoc/build/docs/javadoc/'
+
+      - name: Deploy Javadoc
+        if: ${{ github.event_name == 'push' }}
+        uses: burnett01/rsync-deployments@5.2
+        with:
+          switches: -rlptDvz --mkpath --delete
+          path: combined-javadoc/build/docs/javadoc/
+          remote_path: deephaven-core-v2/${{ github.ref_name }}/javadoc/
+          remote_host: ${{ secrets.DOCS_HOST }}
+          remote_port: ${{ secrets.DOCS_PORT }}
+          remote_user: ${{ secrets.DOCS_USER }}
+          remote_key: ${{ secrets.DEEPHAVEN_CORE_SSH_KEY }}
+
+  typedoc:
+    runs-on: ubuntu-22.04
+    concurrency:
+      group: typedoc-${{ github.workflow }}-${{ github.ref }}
+      # We don't want to cancel in-progress jobs against main because that might leave the upload in a bad state.
+      cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup JDK 11
+        id: setup-java-11
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '11'
+
+      - name: Setup JDK 17
+        id: setup-java-17
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - name: Set JAVA_HOME
+        run: echo "JAVA_HOME=${{ steps.setup-java-11.outputs.path }}" >> $GITHUB_ENV
+
+      - name: Run typedoc on JS API
+        uses: burrunan/gradle-cache-action@v1
+        with:
+          job-id: typedoc
+          arguments: --scan outputVersion :web-client-api:types:typedoc
+          gradle-version: wrapper
+          
+      - name: Get Deephaven Version
+        id: dhc-version
+        run: echo "version=$(cat build/version)" >> $GITHUB_OUTPUT
+          
+      - name: Upload JavaScript/TypeScript docs
+        if: ${{ github.event_name == 'push' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: typedoc-${{ steps.dhc-version.outputs.version }}
+          path: 'web/client-api/types/build/documentation/'
+
+      - name: Deploy JavaScript/TypeScript docs
+        if: ${{ github.event_name == 'push' }}
+        uses: burnett01/rsync-deployments@5.2
+        with:
+          switches: -rlptDvz --mkpath --delete
+          path: web/client-api/types/build/documentation/
+          remote_path: deephaven-core-v2/${{ github.ref_name }}/client-api/javascript/
+          remote_host: ${{ secrets.DOCS_HOST }}
+          remote_port: ${{ secrets.DOCS_PORT }}
+          remote_user: ${{ secrets.DOCS_USER }}
+          remote_key: ${{ secrets.DEEPHAVEN_CORE_SSH_KEY }}
+
+  pydoc:
+    runs-on: ubuntu-22.04
+    concurrency:
+      group: pydoc-${{ github.workflow }}-${{ github.ref }}
+      # We don't want to cancel in-progress jobs against main because that might leave the upload in a bad state.
+      cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup JDK 11
+        id: setup-java-11
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '11'
+
+      - name: Setup JDK 17
+        id: setup-java-17
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - name: Set JAVA_HOME
+        run: echo "JAVA_HOME=${{ steps.setup-java-11.outputs.path }}" >> $GITHUB_ENV
+
+      - name: Setup gradle properties
+        run: |
+          .github/scripts/gradle-properties.sh >> gradle.properties
+          cat gradle.properties
+
+      - name: Generate Python Docs
+        uses: burrunan/gradle-cache-action@v1
+        with:
+          job-id: pythonDocs
+          arguments: --scan outputVersion sphinx:pythonDocs sphinx:pydeephavenDocs
+          gradle-version: wrapper
+ 
+      - name: Get Deephaven Version
+        id: dhc-version
+        run: echo "version=$(cat build/version)" >> $GITHUB_OUTPUT
+ 
+      - name: Upload Python Server Docs
+        if: ${{ github.event_name == 'push' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: pyserver-docs-${{ steps.dhc-version.outputs.version }}
+          path: 'sphinx/build/docs/'
+          
+      - name: Upload Python Client Docs
+        if: ${{ github.event_name == 'push' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: pyclient-docs-${{ steps.dhc-version.outputs.version }}
+          path: 'sphinx/build/pyclient-docs/'
+
+      - name: Deploy Python Docs
+        if: ${{ github.event_name == 'push' }}
+        uses: burnett01/rsync-deployments@5.2
+        with:
+          switches: -rlptDvz --mkpath --delete
+          path: sphinx/build/docs/
+          remote_path: deephaven-core-v2/${{ github.ref_name }}/pydoc/
+          remote_host: ${{ secrets.DOCS_HOST }}
+          remote_port: ${{ secrets.DOCS_PORT }}
+          remote_user: ${{ secrets.DOCS_USER }}
+          remote_key: ${{ secrets.DEEPHAVEN_CORE_SSH_KEY }}
+
+      - name: Deploy Client Python Docs
+        if: ${{ github.event_name == 'push' }}
+        uses: burnett01/rsync-deployments@5.2
+        with:
+          switches: -rlptDvz --mkpath --delete
+          path: sphinx/build/pyclient-docs/
+          remote_path: deephaven-core-v2/${{ github.ref_name }}/client-api/python/
+          remote_host: ${{ secrets.DOCS_HOST }}
+          remote_port: ${{ secrets.DOCS_PORT }}
+          remote_user: ${{ secrets.DOCS_USER }}
+          remote_key: ${{ secrets.DEEPHAVEN_CORE_SSH_KEY }}
+
+      - name: Upload JVM Error Logs
+        uses: actions/upload-artifact@v3
+        if: failure()
+        with:
+          name: docs-ci-pydoc-jvm-err
+          path: '**/*_pid*.log'
+          if-no-files-found: ignore
+
+  cppdoc:
+    runs-on: ubuntu-22.04
+    concurrency:
+      group: cppdoc-${{ github.workflow }}-${{ github.ref }}
+      # We don't want to cancel in-progress jobs against main because that might leave the upload in a bad state.
+      cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup JDK 11
+        id: setup-java-11
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '11'
+
+      - name: Set JAVA_HOME
+        run: echo "JAVA_HOME=${{ steps.setup-java-11.outputs.path }}" >> $GITHUB_ENV
+
+      - name: Setup gradle properties
+        run: |
+          .github/scripts/gradle-properties.sh >> gradle.properties
+          cat gradle.properties
+
+      - name: Generate C++ Docs
+        uses: burrunan/gradle-cache-action@v1
+        with:
+          job-id: cppDocs
+          arguments: --scan outputVersion sphinx:cppClientDocs sphinx:cppExamplesDocs
+          gradle-version: wrapper
+         
+      - name: Get Deephaven Version
+        id: dhc-version
+        run: echo "version=$(cat build/version)" >> $GITHUB_OUTPUT
+  
+      - name: Upload Client C++ Docs
+        if: ${{ github.event_name == 'push' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: cppclient-docs-${{ steps.dhc-version.outputs.version }}
+          path: 'sphinx/build/cppClientDocs/'
+          
+      - name: Upload Client C++ Example Docs
+        if: ${{ github.event_name == 'push' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: cppclient-examples-${{ steps.dhc-version.outputs.version }}
+          path: 'sphinx/build/cppExamplesDocs/'
+
+      - name: Deploy Client C++ Docs
+        if: ${{ github.event_name == 'push' }}
+        uses: burnett01/rsync-deployments@5.2
+        with:
+          switches: -rlptDvz --mkpath --delete
+          path: sphinx/build/cppClientDocs/
+          remote_path: deephaven-core-v2/${{ github.ref_name }}/client-api/cpp/
+          remote_host: ${{ secrets.DOCS_HOST }}
+          remote_port: ${{ secrets.DOCS_PORT }}
+          remote_user: ${{ secrets.DOCS_USER }}
+          remote_key: ${{ secrets.DEEPHAVEN_CORE_SSH_KEY }}
+
+      - name: Deploy Client C++ Example Docs
+        if: ${{ github.event_name == 'push' }}
+        uses: burnett01/rsync-deployments@5.2
+        with:
+          switches: -rlptDvz --mkpath --delete
+          path: sphinx/build/cppExamplesDocs/
+          remote_path: deephaven-core-v2/${{ github.ref_name }}/client-api/cpp-examples/
+          remote_host: ${{ secrets.DOCS_HOST }}
+          remote_port: ${{ secrets.DOCS_PORT }}
+          remote_user: ${{ secrets.DOCS_USER }}
+          remote_key: ${{ secrets.DEEPHAVEN_CORE_SSH_KEY }}
+
+  rdoc:
+    runs-on: ubuntu-22.04
+    concurrency:
+      group: rdoc-${{ github.workflow }}-${{ github.ref }}
+      # We don't want to cancel in-progress jobs against main because that might leave the upload in a bad state.
+      cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup JDK 11
+        id: setup-java-11
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '11'
+
+      - name: Set JAVA_HOME
+        run: echo "JAVA_HOME=${{ steps.setup-java-11.outputs.path }}" >> $GITHUB_ENV
+
+      - name: Setup gradle properties
+        run: |
+          .github/scripts/gradle-properties.sh >> gradle.properties
+          cat gradle.properties
+
+      - name: Generate R Docs
+        uses: burrunan/gradle-cache-action@v1
+        with:
+          job-id: rDocs
+          arguments: --scan outputVersion R:rClientSite
+          gradle-version: wrapper
+          
+      - name: Get Deephaven Version
+        id: dhc-version
+        run: echo "version=$(cat build/version)" >> $GITHUB_OUTPUT
+        
+      - name: Upload R Docs
+        if: ${{ github.event_name == 'push' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: rdoc-${{ steps.dhc-version.outputs.version }}
+          path: 'R/rdeephaven/docs/'
+
+      - name: Deploy R Docs
+        if: ${{ github.event_name == 'push' }}
+        uses: burnett01/rsync-deployments@5.2
+        with:
+          switches: -rlptDvz --mkpath --delete
+          path: R/rdeephaven/docs/
+          remote_path: deephaven-core-v2/${{ github.ref_name }}/client-api/r/
+          remote_host: ${{ secrets.DOCS_HOST }}
+          remote_port: ${{ secrets.DOCS_PORT }}
+          remote_user: ${{ secrets.DOCS_USER }}
+          remote_key: ${{ secrets.DEEPHAVEN_CORE_SSH_KEY }}
+
+      - name: Upload JVM Error Logs
+        uses: actions/upload-artifact@v3
+        if: failure()