Skip to content

Commit b4dae8f

Browse files
Add CI task to validate documentation
1 parent bd673ea commit b4dae8f

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

.cirrus.yml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ poetry_win_install: &POETRY_WIN_INSTALL
7878
poetry_cache_template: &POETRY_CACHE
7979
poetry_cache:
8080
folder: ~/.cache/poetry/
81-
fingerprint_script: cat poetry.lock
81+
fingerprint_script: cat poetry.lock
8282

8383
.poetry_template: &POETRY_TEMPLATE
8484
<<: *POETRY_CACHE
@@ -152,6 +152,14 @@ formatting_task:
152152
- poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2024 -n "Sonar Scanner Python" -E .py -d tests/
153153
- git diff --name-only --exit-code ./src ./tests
154154

155+
documentation_task:
156+
<<: *POETRY_LINUX_TEMPLATE
157+
alias: documentation
158+
name: "CLI Documentation Check"
159+
cli_docs_script:
160+
- poetry run python tools/generate_cli_documentation.py
161+
- git diff --exit-code CLI_ARGS.md
162+
155163
analysis_linux_task:
156164
<<: *POETRY_LINUX_TEMPLATE
157165
alias: analysis

0 commit comments

Comments
 (0)