AgentContextOS/.github/workflows/docs.yml at main · officialCodeWork/AgentContextOS · 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
name: Docs

on:
  pull_request:
    paths:
      - "docs/**"
      - "website/**"
      - "dist/openapi.json"
      - "scripts/gen_api_reference.py"
      - "tests/docs/**"
      - ".github/workflows/docs.yml"
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "website/**"
      - "dist/openapi.json"
      - "scripts/gen_api_reference.py"

permissions:
  contents: read

jobs:
  api-reference-drift:
    name: API reference drift
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - name: Regenerate + diff rest-api.md
        run: |
          python scripts/gen_api_reference.py
          git diff --exit-code docs/reference/rest-api.md \
            || { echo "::error::docs/reference/rest-api.md is stale — run 'task docs:api'"; exit 1; }

  quickstart-tests:
    name: Quickstart doc tests
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v4
      - uses: astral-sh/setup-uv@v6
      - run: uv run pytest tests/docs -q

  spell-check:
    name: Spell check
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v4
      - uses: codespell-project/actions-codespell@v2
        with:
          path: docs
          skip: "*.svg,*.json,*.html,./dist,./docs/research"
          ignore_words_list: "ba,nin,te,ist,fo,ot,assertIn,iif"

  link-check:
    name: Link check (offline)
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v4
      - uses: lycheeverse/lychee-action@v2
        with:
          args: "--offline --include-fragments docs/**/*.md website/README.md README.md"
          fail: true

  build:
    name: Docusaurus build
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
      - name: Generate API reference
        run: python scripts/gen_api_reference.py
      - name: Build site
        run: |
          cd website
          npm install
          npm run build