laya/.github/workflows/docs.yml at main · radicazz/laya · 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
88
89
name: Documentation

on:
  push:
    branches:
      - main
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - 'tools/pyproject.toml'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

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

env:
  ACT: 'false'

jobs:
  build-deploy:
    name: Build and Deploy Documentation
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.12'

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

    - name: Sync Python dependencies
      run: |
        cd tools
        uv sync --group docs

    - name: Build documentation
      run: |
        uv run --directory tools mkdocs build --clean --config-file ../mkdocs.yml --site-dir site

    - name: Upload artifact for GitHub Pages
      if: ${{ env.ACT != 'true' }}
      uses: actions/upload-pages-artifact@v3
      with:
        path: site/

    - name: Deploy to GitHub Pages
      if: ${{ env.ACT != 'true' }}
      id: deployment
      uses: actions/deploy-pages@v4

  build-preview:
    name: Build Documentation (Preview)
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.12'

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

    - name: Sync Python dependencies
      run: |
        cd tools
        uv sync --group docs

    - name: Build documentation
      run: |
        uv run --directory tools mkdocs build --clean --config-file ../mkdocs.yml --site-dir site

    - name: Upload preview artifact
      uses: actions/upload-artifact@v4
      with:
        name: docs-preview
        path: site/
        retention-days: 7