Skip to content

Commit 1264b71

Browse files
committed
ci: add documentation validation to test workflow
- Add validate-docs job that runs before tests - Check documentation coverage (must be 100%) - Validate required Doxygen tags (@brief, @param, @return) - Tests depend on passing documentation validation This ensures all PRs maintain documentation quality standards.
1 parent ee96e15 commit 1264b71

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

.github/workflows/test-eql.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,27 @@ defaults:
2626
shell: bash -l {0}
2727

2828
jobs:
29+
validate-docs:
30+
name: "Validate SQL Documentation"
31+
runs-on: ubuntu-latest-m
32+
33+
steps:
34+
- uses: actions/checkout@v4
35+
36+
- name: Check documentation coverage
37+
run: |
38+
chmod +x tasks/check-doc-coverage.sh
39+
./tasks/check-doc-coverage.sh
40+
41+
- name: Validate required Doxygen tags
42+
run: |
43+
chmod +x tasks/validate-required-tags.sh
44+
./tasks/validate-required-tags.sh
45+
2946
test:
3047
name: "Test EQL SQL components"
3148
runs-on: ubuntu-latest-m
49+
needs: validate-docs
3250

3351
strategy:
3452
fail-fast: false

0 commit comments

Comments
 (0)