internet/kubevirt.core
3
0
Fork 0
mirror of https://github.com/kubevirt/kubevirt.core.git synced 2026-07-25 08:54:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify local tox setup and unit test matrix usage

Browse Source 
Document tox 4 requirement and PATH fix for --user installs so make
targets use the correct tox binary. Describe how to use selective
unit test environments instead of running the full matrix.

Signed-off-by: Geetika Kapoor <gkapoor@redhat.com>
This commit is contained in:
Geetika Kapoor
2026-06-09 13:44:46 +01:00
parent 9eb27d287f
commit 6d85ed42f1
2 changed files with 25 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/developing.md
View File

@@ -14,11 +14,23 @@
## Development environment
To develop and to run tests you need to install `tox` and `tox-ansible` on
your machine.
Install `tox` (version 4 or newer) and `tox-ansible`:
```
pip install --user tox tox-ansible
pip install --user 'tox>=4' tox-ansible
```
With `--user`, `tox` is in `~/.local/bin`. Put it first on `PATH` before
`make` targets that use `tox` (`build-venv`, `test-unit`, `test-sanity`):
```
export PATH="$HOME/.local/bin:$PATH" # whole shell session
```
or
```
PATH="$HOME/.local/bin:$PATH" make <target> # command only
```
### Virtualenv for development