Skip to content

Commit 8bb541a

Browse files
authored
docs: Update CLI documentation workflow to include argument file and improve description (#2695)
1 parent d02af31 commit 8bb541a

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

.github/workflows/cli-docs.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ on:
66
paths:
77
- 'tests/main/**'
88
- 'tests/test_main_kr.py'
9+
- 'src/datamodel_code_generator/arguments.py'
910
- 'src/datamodel_code_generator/cli_options.py'
1011
- 'scripts/build_cli_docs.py'
1112
pull_request:
1213
branches: [main]
1314
paths:
1415
- 'tests/main/**'
1516
- 'tests/test_main_kr.py'
17+
- 'src/datamodel_code_generator/arguments.py'
1618
- 'src/datamodel_code_generator/cli_options.py'
1719
- 'scripts/build_cli_docs.py'
1820

tox.ini

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,10 @@ dependency_groups =
7070
no_default_groups = true
7171

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

0 commit comments

Comments
 (0)