Neural/.github/workflows/docs.yml at main · IntelIP/Neural · 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
name: Documentation

on:
  push:
    branches: [main, develop]
    paths:
      - "docs/**"
      - "docs-site/**"
      - "examples/**"
      - "neural/**/*.py"
      - "README.md"
      - "CONTRIBUTING.md"
      - ".github/workflows/docs.yml"
  pull_request:
    branches: [main]
    paths:
      - "docs/**"
      - "docs-site/**"
      - "examples/**"
      - "neural/**/*.py"
      - "README.md"
      - "CONTRIBUTING.md"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

permissions:
  contents: read

jobs:
  content:
    name: Validate Documentation Content
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up uv
        uses: astral-sh/setup-uv@v7
        with:
          python-version: "3.11"
          enable-cache: true

      - name: Sync Python validation dependencies
        run: uv sync --extra dev

      - name: Validate documentation
        run: uv run python scripts/validate_docs.py

      - name: Validate examples
        run: uv run python scripts/validate_examples.py

  site:
    name: Build Fumadocs Site
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up Bun
        uses: oven-sh/setup-bun@v2
        with:
          bun-version: "1.3.3"

      - name: Install locked dependencies
        working-directory: docs-site
        run: bun install --frozen-lockfile

      - name: Typecheck
        working-directory: docs-site
        run: bun run typecheck

      - name: Build
        working-directory: docs-site
        run: bun run build

      - name: Documentation summary
        run: |
          echo "## Fumadocs validation" >> "$GITHUB_STEP_SUMMARY"
          echo "- Fumadocs dependencies installed from bun.lock" >> "$GITHUB_STEP_SUMMARY"
          echo "- TypeScript passed" >> "$GITHUB_STEP_SUMMARY"
          echo "- Production build passed" >> "$GITHUB_STEP_SUMMARY"
          echo "- Deployment intentionally excluded" >> "$GITHUB_STEP_SUMMARY"