vortex/.github/workflows/docs-build.yml at develop · vortex-data/vortex · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: Copyright the Vortex contributors

name: Build Vortex Docs

on:
  workflow_call:
    outputs:
      artifact-id:
        description: "HTML artifact for this build"
        value: ${{ jobs.build.outputs.artifact-id }}

# Inherit the caller's token permissions. Production includes draft releases,
# which require contents: write. Previews use contents: read and published releases.
jobs:
  build:
    runs-on: ubuntu-latest
    timeout-minutes: 30
    outputs:
      artifact-id: ${{ steps.artifact.outputs.artifact-id }}
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7
        with:
          ref: ${{ github.event.pull_request.head.sha || github.sha }}
          persist-credentials: false
      - uses: ./.github/actions/setup-rust
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
      - name: Set up JDK 17
        uses: actions/setup-java@de7274f081f381c8f8158605e0321c36c376e2e6  # v6
        with:
          java-version: "17"
          distribution: "temurin"
      - name: Install uv
        uses: spiraldb/actions/.github/actions/setup-uv@a746510eafaa926484c354541cfc49b2ec06cc63  # 0.18.6
        with:
          sync: false
          prune-cache: false
      - name: Generate changelog from GitHub releases
        run: uv run --no-project docs/generate_changelog.py
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      - name: Generate Javadoc for Java projects
        run: |
          cd java
          ./gradlew javadoc -x makeTestFiles
      - name: Copy Javadoc to docs directory
        run: |
          mkdir -p docs/_static/vortex-jni
          mkdir -p docs/_static/vortex-spark
          cp -r java/vortex-jni/build/docs/javadoc/* docs/_static/vortex-jni/
          cp -r java/vortex-spark/build/vortex-spark_2.13/docs/javadoc/* docs/_static/vortex-spark/
      - name: Build Python and Rust docs
        run: uv run --all-packages make -C docs html
      - name: Upload HTML
        id: artifact
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7
        with:
          name: vortex-docs-${{ github.run_attempt }}
          path: docs/_build/html
          include-hidden-files: true
          if-no-files-found: error
          retention-days: 7