Skip to content

Commit 128ab20

Browse files
committed
docs/developing.md(docs[testing]): document runtime smoke test
why: contributors need guidance on exercising the isolated runtime dependency smoke test. what: - add section showing how to run the script via uvx and via the pytest marker. - call out that the check relies on network access.
1 parent 20946cd commit 128ab20

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/developing.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,24 @@ or:
6464
$ make test
6565
```
6666

67+
#### Runtime dependency smoke test
68+
69+
Verify that the published wheel runs without dev/test extras:
70+
71+
```console
72+
$ uvx --isolated --reinstall --from . python scripts/runtime_dep_smoketest.py
73+
```
74+
75+
The script imports every ``vcspull`` module and exercises each CLI sub-command
76+
with ``--help``. There is also a pytest wrapper guarded by a dedicated marker:
77+
78+
```console
79+
$ uv run pytest -m scripts__runtime_dep_smoketest scripts/test_runtime_dep_smoketest.py
80+
```
81+
82+
These checks are network-dependent because they rely on ``uvx`` to build the
83+
package in an isolated environment.
84+
6785
#### pytest options
6886

6987
`PYTEST_ADDOPTS` can be set in the commands below. For more

0 commit comments

Comments
 (0)