-
-
Notifications
You must be signed in to change notification settings - Fork 0
56 lines (47 loc) · 1.59 KB
/
Copy pathdocs-auto.yml
File metadata and controls
56 lines (47 loc) · 1.59 KB
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
name: Auto-Generate Documentation
on:
pull_request:
paths:
- 'src/**'
- 'typedoc.json'
- 'Doxyfile'
- 'README.md'
push:
branches: [ main, develop ]
tags:
- 'v*'
paths:
- 'src/**'
- 'typedoc.json'
- 'Doxyfile'
jobs:
check-docs:
name: Verify Documentation Generation
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
- name: Install dependencies
run: npm ci --ignore-scripts
- name: Install Doxygen
run: |
sudo apt-get update
sudo apt-get install -y doxygen graphviz
- name: Generate documentation
run: npm run docs
- name: Check documentation files
run: |
echo "=== Checking TypeDoc output ==="
test -d docs/api && echo "✅ TypeDoc docs generated" || (echo "❌ TypeDoc docs missing" && exit 1)
test -f docs/api/index.html && echo "✅ TypeDoc index.html exists" || (echo "❌ TypeDoc index.html missing" && exit 1)
echo ""
echo "=== Checking Doxygen output ==="
test -d docs/html && echo "✅ Doxygen docs generated" || (echo "❌ Doxygen docs missing" && exit 1)
test -f docs/html/index.html && echo "✅ Doxygen index.html exists" || (echo "❌ Doxygen index.html missing" && exit 1)
echo ""
echo "✅ All documentation generated successfully!"