website/.github/workflows/docs-audit.yml at master · oro-computer/website · 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
name: Docs Audit

on:
  pull_request:
  push:
    branches:
      - main
      - master
  workflow_dispatch:

jobs:
  docs-audit:
    runs-on: ubuntu-latest

    steps:
      - name: Check out repository
        uses: actions/checkout@v4

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

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "20"

      - name: Rebuild generated docs artifacts
        run: |
          python3 runtime/tools/build-indexes.py
          python3 runtime/tools/build-llms-txt.py

          python3 sage/tools/build-indexes.py
          python3 sage/tools/build-llms-txt.py

          python3 slg/tools/build-indexes.py
          python3 slg/tools/build-llms-txt.py

          python3 virtnosis/tools/build-indexes.py
          python3 virtnosis/tools/build-llms-txt.py

          python3 silk/tools/build-indexes.py
          python3 silk/tools/build-llms-txt.py

      - name: Run docs audits
        run: |
          python3 runtime/tools/audit-site.py
          python3 sage/tools/audit-site.py
          python3 slg/tools/audit-site.py
          python3 virtnosis/tools/audit-site.py
          python3 silk/tools/audit-site.py
          python3 silk/tools/audit-stdlib-docs.py

      - name: Run static checks
        run: |
          python3 -m py_compile runtime/tools/*.py
          python3 -m py_compile sage/tools/*.py
          python3 -m py_compile slg/tools/*.py
          python3 -m py_compile virtnosis/tools/*.py
          python3 -m py_compile silk/tools/*.py

          node --check assets/docs-viewer.js
          node --check assets/spec-viewer.js
          node --check assets/site.js

          git diff --check
          git diff --exit-code -- \
            runtime/docs/index.json \
            runtime/docs/search.json \
            runtime/llms.txt \
            sage/docs/index.json \
            sage/docs/search.json \
            sage/llms.txt \
            slg/docs/index.json \
            slg/docs/search.json \
            slg/llms.txt \
            virtnosis/docs/index.json \
            virtnosis/docs/search.json \
            virtnosis/llms.txt \
            silk/docs/index.json \
            silk/docs/search.json \
            silk/wiki/index.json \
            silk/wiki/search.json \
            silk/llms.txt