-
Notifications
You must be signed in to change notification settings - Fork 0
64 lines (51 loc) · 1.25 KB
/
Copy pathdocs.yml
File metadata and controls
64 lines (51 loc) · 1.25 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
name: Docs
on:
pull_request:
paths:
- '**/*.md'
- 'docs/**'
- '.github/workflows/docs.yml'
push:
branches:
- main
paths:
- '**/*.md'
- 'docs/**'
- '.github/workflows/docs.yml'
workflow_dispatch:
permissions:
contents: read
jobs:
docs-hygiene:
name: Docs hygiene
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v6
- name: Set up pnpm
uses: pnpm/action-setup@v4
with:
version: 9
- name: Set up Node
uses: actions/setup-node@v6
with:
node-version: '22'
cache: pnpm
- name: Validate docs directory
run: |
set -euo pipefail
test -d docs
test -s docs/PRD.md
- name: Validate markdown paths
run: |
set -euo pipefail
find . -type f -name '*.md' -not -path './.git/*' -print | sort > markdown-files.txt
test -s markdown-files.txt
while IFS= read -r file; do
test -s "$file"
done < markdown-files.txt
- name: Run docs release-readiness check
run: |
set -euo pipefail
pnpm install --frozen-lockfile
pnpm run docs:check