-
-
Notifications
You must be signed in to change notification settings - Fork 1
41 lines (36 loc) · 965 Bytes
/
docs.yml
File metadata and controls
41 lines (36 loc) · 965 Bytes
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
name: Documentation Check
on:
push:
branches: [ main, master, develop ]
paths:
- '*.md'
- 'docs/**'
- 'bindings/**/*.md'
- '.github/workflows/docs.yml'
pull_request:
paths:
- '*.md'
- 'docs/**'
- 'bindings/**/*.md'
- '.github/workflows/docs.yml'
workflow_dispatch:
jobs:
docs-check:
name: Documentation Check
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v6
- name: Validate documentation
run: |
echo "Checking documentation files..."
test -f README.md
test -d docs
test -n "$(find docs -name '*.md' 2>/dev/null)"
echo "All documentation files present"
- name: Check for broken links
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
config-file: '.github/markdown-link-check.json'
continue-on-error: true