docs-ci.yml

name: Docs CI

on:
  pull_request:
    branches: [ main ]
  push:
    branches: [ main ]

jobs:
  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@v3
        with:
          distribution: 'temurin'
          java-version: '11'

      - name: Setup JDK 17
        id: setup-java-17
        uses: actions/setup-java@v3
        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 combined-javadoc:allJavadoc
          gradle-version: wrapper

      - name: Upload Javadocs
        if: ${{ github.ref == 'refs/heads/main' }}
        uses: actions/upload-artifact@v3
        with:
          name: javadocs
          path: 'combined-javadoc/build/docs/javadoc/'

      - name: Deploy Javadoc
        if: ${{ github.ref == 'refs/heads/main' }}
        uses: burnett01/rsync-deployments@5.2
        with:
          switches: -avzr --delete
          path: combined-javadoc/build/docs/javadoc/
          remote_path: deephaven-core/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@v3
        with:
          distribution: 'temurin'
          java-version: '11'

      - name: Setup JDK 17
        id: setup-java-17
        uses: actions/setup-java@v3
        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 :web-client-api:types:typedoc
          gradle-version: wrapper
      - name: Upload JavaScript/TypeScript docs
        if: ${{ github.ref == 'refs/heads/main' }}
        uses: actions/upload-artifact@v3
        with:
          name: typedoc
          path: 'web/client-api/types/build/documentation/'
      - name: Deploy JavaScript/TypeScript docs
        if: ${{ github.ref == 'refs/heads/main' }}
        uses: burnett01/rsync-deployments@5.2
        with:
          switches: -avzr --delete
          path: web/client-api/types/build/documentation/
          remote_path: deephaven-core/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@v3
        with:
          distribution: 'temurin'
          java-version: '11'

      - name: Setup JDK 17
        id: setup-java-17
        uses: actions/setup-java@v3
        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 sphinx:pythonDocs sphinx:pydeephavenDocs
          gradle-version: wrapper

      - name: Deploy Python Docs
        if: ${{ github.ref == 'refs/heads/main' }}
        uses: burnett01/rsync-deployments@5.2
        with:
          switches: -avzr --delete
          path: sphinx/build/docs/
          remote_path: deephaven-core/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.ref == 'refs/heads/main' }}
        uses: burnett01/rsync-deployments@5.2
        with:
          switches: -avzr --delete
          path: sphinx/build/pyclient-docs/
          remote_path: deephaven-core/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@v3
        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 sphinx:cppClientDocs sphinx:cppExamplesDocs
          gradle-version: wrapper

      - name: Deploy Client C++ Docs
        if: ${{ github.ref == 'refs/heads/main' }}
        uses: burnett01/rsync-deployments@5.2
        with:
          switches: -avzr --delete
          path: sphinx/build/cppClientDocs/
          remote_path: deephaven-core/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.ref == 'refs/heads/main' }}
        uses: burnett01/rsync-deployments@5.2
        with:
          switches: -avzr --delete
          path: sphinx/build/cppExamplesDocs/
          remote_path: deephaven-core/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@v3
        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: R:rClientSite
          gradle-version: wrapper

      - name: Deploy R Docs
        if: ${{ github.ref == 'refs/heads/main' }}
        uses: burnett01/rsync-deployments@5.2
        with:
          switches: -avzr --delete
          path: R/rdeephaven/docs/
          remote_path: deephaven-core/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()