FastAPI-CacheX/.github/workflows/docs.yml at master · allen0099/FastAPI-CacheX · 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
name: Docs

on:
  push:
    branches: [ "master" ]
    paths:
      - 'docs/**'
      - 'fastapi_cachex/**'
      - 'README.md'
      - 'CHANGELOG.md'
      - 'zensical.toml'
      - 'zensical.zh-TW.toml'
      - 'i18n/**'
      - 'examples/**'
      - 'pyproject.toml'
      - 'uv.lock'
      - '.github/workflows/docs.yml'
  pull_request:
    branches: [ "master" ]
    paths:
      - 'docs/**'
      - 'fastapi_cachex/**'
      - 'README.md'
      - 'CHANGELOG.md'
      - 'zensical.toml'
      - 'zensical.zh-TW.toml'
      - 'i18n/**'
      - 'examples/**'
      - 'pyproject.toml'
      - 'uv.lock'
      - '.github/workflows/docs.yml'

permissions:
  contents: read

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      with:
        persist-credentials: false

    - name: Set up Python
      uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
      with:
        python-version: "3.14"

    - name: Install uv
      uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0

    # Same command Read the Docs runs; a broken link or docstring reference
    # fails the PR here instead of the published site.
    - name: Sync dependencies
      run: uv sync --frozen --only-group docs --no-install-project

    - name: Build (strict)
      run: uv run --no-sync zensical build --strict

    - name: Build Traditional Chinese translation (strict)
      run: uv run --no-sync zensical build --strict -f zensical.zh-TW.toml