graphrefly-py/.github/workflows/docs.yml at main · graphrefly/graphrefly-py · 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
name: Deploy docs to GitHub Pages

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

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: python-pages-${{ github.ref }}
  cancel-in-progress: false

env:
  PY_DOCS_CUSTOM_DOMAIN: py.graphrefly.dev

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Python host package
        uses: actions/checkout@v7
        with:
          path: graphrefly-py

      - name: Install uv
        uses: astral-sh/setup-uv@v8.3.2

      - name: Set up Node
        uses: actions/setup-node@v6
        with:
          node-version: "24"
          package-manager-cache: false

      - name: Enable Corepack (pnpm)
        working-directory: graphrefly-py/website
        run: |
          corepack enable
          corepack install

      - name: Install Python docs dependencies
        working-directory: graphrefly-py
        run: uv sync --group dev --group docs

      - name: Install docs website dependencies
        working-directory: graphrefly-py/website
        run: pnpm install --frozen-lockfile

      - name: API docs coverage
        working-directory: graphrefly-py
        run: uv run python scripts/check_api_docs.py

      - name: Generated docs freshness
        working-directory: graphrefly-py/website
        run: pnpm docs:gen:check

      - name: Build site
        working-directory: graphrefly-py/website
        run: pnpm build

      - name: Upload Pages artifact
        if: github.event_name != 'pull_request'
        uses: actions/upload-pages-artifact@v5
        with:
          path: graphrefly-py/website/dist

  deploy:
    if: github.event_name != 'pull_request'
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5