LitLogger/.github/workflows/ci-docs.yaml at ddbfa7df6ba58e250b824f10031bc0c410e441e4 · Lightning-AI/LitLogger · 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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
name: Docs

on:
  push:
    branches: ["main"]
  pull_request:
    types: [opened, reopened, ready_for_review, synchronize]

jobs:
  docs-build:
    runs-on: ubuntu-latest
    if: github.event.pull_request.draft == false
    timeout-minutes: 10

    steps:
    - uses: actions/checkout@v5

    - name: Install uv and setup python
      uses: astral-sh/setup-uv@v6
      with:
        activate-environment: true
        python-version: "3.12"
        enable-cache: true

    - name: Install package & doc dependencies
      run: |
        uv sync --group docs
        uv pip list

    - name: Build docs
      working-directory: docs/source
      run: |
        make html SPHINXOPTS="-W --keep-going"

    - name: Upload docs artifact
      if: github.event_name == 'pull_request'
      uses: actions/upload-artifact@v4
      with:
        name: docs-build
        path: docs/build/html/
        retention-days: 7

  docs-linkcheck:
    runs-on: ubuntu-latest
    if: github.event.pull_request.draft == false
    timeout-minutes: 10

    steps:
    - uses: actions/checkout@v5

    - name: Install uv and setup python
      uses: astral-sh/setup-uv@v6
      with:
        activate-environment: true
        python-version: "3.12"
        enable-cache: true

    - name: Install package & doc dependencies
      run: |
        uv sync --group docs
        uv pip list

    - name: Check links
      working-directory: docs/source
      run: |
        make linkcheck

  docs-doctest:
    runs-on: ubuntu-latest
    if: github.event.pull_request.draft == false
    timeout-minutes: 10

    steps:
    - uses: actions/checkout@v5

    - name: Install uv and setup python
      uses: astral-sh/setup-uv@v6
      with:
        activate-environment: true
        python-version: "3.12"
        enable-cache: true

    - name: Install package & doc dependencies
      run: |
        uv sync --group docs
        uv pip list

    - name: Run doctests
      working-directory: docs/source
      run: |
        make doctest

  guardian-docs:
    runs-on: ubuntu-latest
    needs: [docs-build, docs-linkcheck, docs-doctest]
    if: always()
    steps:
    - run: |
        echo "build: ${{ needs.docs-build.result }}"
        echo "linkcheck: ${{ needs.docs-linkcheck.result }}"
        echo "doctest: ${{ needs.docs-doctest.result }}"
    - name: failing...
      if: |
        needs.docs-build.result == 'failure' ||
        needs.docs-linkcheck.result == 'failure' ||
        needs.docs-doctest.result == 'failure'
      run: exit 1
    - name: cancelled or skipped...
      if: |
        contains(fromJSON('["cancelled", "skipped"]'), needs.docs-build.result) ||
        contains(fromJSON('["cancelled", "skipped"]'), needs.docs-linkcheck.result) ||
        contains(fromJSON('["cancelled", "skipped"]'), needs.docs-doctest.result)
      timeout-minutes: 1
      run: sleep 90