python-graph-visualization/.github/workflows/render-docs.yml at main · neo4j/python-graph-visualization · 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
name: Render docs

# Controls when the workflow will run
on:
  # Triggers the workflow on push or pull request events but only for the "main" branch
  push:
    branches: ["main"]
  pull_request:
    paths:
      - "python-wrapper/**" # python code
      - "docs/**" # documentation
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  ref-docs:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    defaults:
      run:
        working-directory: python-wrapper

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - name: Patch eMudhra CA compromise (CVE-2026-111943)
        shell: bash
        working-directory: .
        run: |
          sudo apt-get update
          sudo apt-get install --only-upgrade -y ca-certificates
          sudo update-ca-certificates --fresh

      - name: Install uv and set the Python version
        uses: astral-sh/setup-uv@07a047e608db84b3d8c06cd9a7c7dcc9c355c18e # v10.3.2
        with:
          python-version: "3.13"
          enable-cache: true

      - name: Build the JS applet
        uses: ./.github/actions/build-js

      - run: uv sync --group dev --group docs --extra pandas --extra neo4j --extra gds --extra snowflake

      - name: Setup pandoc
        uses: pandoc/actions/setup@86321b6dd4675f5014c611e05088e10d4939e09e # v1
        with:
          version: 3.6.2

      - name: Render ref docs
        run: uv run bash ../scripts/render_api_docs.sh

  antora-docs:
    runs-on: ubuntu-latest

    defaults:
      run:
        working-directory: docs/antora

    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - name: Patch eMudhra CA compromise (CVE-2026-111943)
        shell: bash
        working-directory: .
        run: |
          sudo apt-get update
          sudo apt-get install --only-upgrade -y ca-certificates
          sudo update-ca-certificates --fresh

      - name: Set up Node
        uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
        with:
          node-version-file: .nvmrc
          cache: npm
          cache-dependency-path: docs/antora/package-lock.json

      - name: Build Antora docs (fail on warnings)
        run: |
          npm ci
          npm run verify
          # Antora can exit 0 without generating a site (observed with Antora
          # 3.1.x on newer Node); guard against that silent no-op.
          test -f build/site/index.html || { echo '::error::Antora did not generate a site'; exit 1; }