msgspec/.github/workflows/docs.yml at main · kumaraditya303/msgspec · 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
name: documentation

on:
  push:
    branches:
    - main
  pull_request: null

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout code
      uses: actions/checkout@v5

    - name: Load environment file
      uses: ./.github/actions/load-env

    - name: Install Python
      uses: actions/setup-python@v6
      with:
        python-version-file: pyproject.toml

    - name: Install uv
      uses: astral-sh/setup-uv@v7

    - name: Install command runner
      run: uv tool install rust-just

    - name: Install dependencies
      run: just env-sync doc

    - name: Build documentation
      run: just doc-build

    - name: Restore link check cache
      uses: actions/cache@v4
      with:
        path: .lycheecache
        key: cache-lychee-${{ github.sha }}
        restore-keys: cache-lychee-

    - name: Check links
      uses: lycheeverse/lychee-action@v2
      with:
        lycheeVersion: v0.21.0
        fail: true
        failIfEmpty: true
        token: "${{ github.token }}"
        args: >-
          --verbose
          --no-progress
          README.md
          docs/build

    - name: Deploy
      uses: peaceiris/actions-gh-pages@v4
      if: github.ref == 'refs/heads/main'
      with:
        github_token: "${{ github.token }}"
        publish_dir: docs/build/html