Skip to content

ci: Improve CLI docs generation workflow #2695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
koxudaxi merged 1 commit into from
Dec 19, 2025
Merged

ci: Improve CLI docs generation workflow #2695

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/cli-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ on:
paths:
- 'tests/main/**'
- 'tests/test_main_kr.py'
- 'src/datamodel_code_generator/arguments.py'
- 'src/datamodel_code_generator/cli_options.py'
- 'scripts/build_cli_docs.py'
pull_request:
branches: [main]
paths:
- 'tests/main/**'
- 'tests/test_main_kr.py'
- 'src/datamodel_code_generator/arguments.py'
- 'src/datamodel_code_generator/cli_options.py'
- 'scripts/build_cli_docs.py'

Expand Down
4 changes: 2 additions & 2 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,10 @@ dependency_groups =
no_default_groups = true

[testenv:cli-docs]
description = Check CLI documentation is up to date
description = Build CLI documentation (use --check to validate only)
commands =
pytest --collect-cli-docs -p no:xdist -q
python scripts/build_cli_docs.py {posargs:--check}
python scripts/build_cli_docs.py {posargs}
dependency_groups = test
no_default_groups = true

Expand Down
Loading