docs.yml

# Copyright (c) Facebook, Inc. and its affiliates.
#
# Licensed 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.

name: Build Documentation

on:
  push:
    paths:
      - velox/docs/**
      - .github/workflows/docs.yml

  pull_request:
    paths:
      - velox/docs/**
      - .github/workflows/docs.yml

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.repository }}-${{ github.head_ref || github.sha }}
  cancel-in-progress: ${{github.ref != 'refs/heads/presto-0.293-clp-connector'}}

jobs:
  build_docs:
    name: Build
    runs-on: ubuntu-latest
    env:
      CCACHE_DIR: /tmp/ccache
    steps:
      - name: Restore ccache
        if: false
        uses: apache/infrastructure-actions/stash/restore@3354c1565d4b0e335b78a76aedd82153a9e144d4
        id: restore-cache
        with:
          path: ${{ env.CCACHE_DIR }}
          key: ccache-wheels-8-core-ubuntu

      - name: Checkout
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
        with:
          fetch-depth: 0
          persist-credentials: true

      - name: Install System Dependencies
        run: |
          sudo apt install -y pipx
          pipx install --force uv cmake==3.31

      - name: Install Python Dependencies
        run: |
          which uv
          make python-venv
          which uv
          uv pip install -r scripts/docs-requirements.txt

      - name: Save ccache
        uses: apache/infrastructure-actions/stash/save@3354c1565d4b0e335b78a76aedd82153a9e144d4
        with:
          path: ${{ env.CCACHE_DIR }}
          key: ccache-wheels-8-core-ubuntu

      - name: Build Documentation
        run: |
          source .venv/bin/activate
          cd velox/docs
          make clean
          make html