-
-
Notifications
You must be signed in to change notification settings - Fork 1
82 lines (70 loc) · 1.84 KB
/
docs-ci.yml
File metadata and controls
82 lines (70 loc) · 1.84 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
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 CI
on:
push:
branches:
- '**'
paths:
- '**.md'
- 'docs/**'
pull_request:
branches:
- '**'
paths:
- '**.md'
- 'docs/**'
workflow_dispatch:
concurrency:
group: docs-ci-${{ github.ref }}
cancel-in-progress: true
jobs:
markdown-lint:
runs-on: ubuntu-latest
name: Markdown Lint
steps:
- name: Checkout
uses: actions/checkout@v6
- name: Lint Markdown files
uses: DavidAnson/markdownlint-cli2-action@v23
with:
globs: |
**/*.md
!node_modules
!.github
- name: Summary
run: |
echo "✅ Markdown linting passed"
link-checker:
runs-on: ubuntu-latest
name: Check Links
steps:
- name: Checkout
uses: actions/checkout@v6
- name: Check links in markdown files
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
config-file: '.github/markdown-link-check-config.json'
check-modified-files-only: 'yes'
base-branch: 'main'
- name: Summary
if: success()
run: |
echo "✅ Link checking passed"
docs-summary:
runs-on: ubuntu-latest
name: Docs CI Summary
needs: [markdown-lint, link-checker]
if: always()
steps:
- name: Check job results
run: |
if [ "${{ needs.markdown-lint.result }}" = "success" ] && [ "${{ needs.link-checker.result }}" = "success" ]; then
echo "✅ All documentation checks passed"
exit 0
elif [ "${{ needs.link-checker.result }}" = "failure" ]; then
echo "⚠️ Link checker failed (non-blocking)"
exit 0
else
echo "❌ Documentation checks failed"
exit 1
fi