Skip to content

Commit 7f64e30

Browse files
committed
add documentation quality workflow
1 parent 0b59a50 commit 7f64e30

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

.github/workflows/docs-check.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Documentation Quality Check
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
jobs:
8+
docs-check:
9+
name: Validate documentation files
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v4
15+
16+
- name: Check required documentation files
17+
run: |
18+
test -f README.md
19+
test -f package.json
20+
21+
- name: Check for JSDoc comments in utility files
22+
run: |
23+
grep -q "@param" headers.js
24+
grep -q "@returns" headers.js
25+
grep -q "@param" rest.js
26+
grep -q "@returns" rest.js
27+
grep -q "@param" predicates.js
28+
grep -q "@returns" predicates.js
29+
grep -q "@param" versioning.js
30+
grep -q "@returns" versioning.js
31+
32+
- name: Check for TODO placeholders in documentation
33+
run: |
34+
! grep -R "TODO: documentation" README.md *.js

0 commit comments

Comments
 (0)