Skip to content

Commit dcf3438

Browse files
committed
feat(docs): explain the tox environments
1 parent bc7ea0a commit dcf3438

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

config/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -377,6 +377,9 @@ _custom configuration_
377377

378378
### `tox.ini`
379379

380+
381+
#### Testing
382+
380383
Depending on the test runner that you want to use,
381384
`plone/meta` will adapt `tox.ini` to it.
382385

@@ -390,6 +393,23 @@ and thus the tests can be found directly.
390393

391394
If either a `tests` or `src` folder exists, then they are used as a safe fallbacks.
392395

396+
#### Environments
397+
398+
`plone/meta` generates the following `tox` environments:
399+
400+
- `init`: prepares the environment (only if `mxdev` is used)
401+
- `test`: runs the package's python tests
402+
- `coverage`: runs the package's python tests and generates a coverage report out of it
403+
- `dependencies`: checks that all python dependencies are specified properly
404+
- `dependencies-graph`: generates a graph to visualize the dependencies tree/forest
405+
- `circular`: checks that within the dependency graph there are no circular imports
406+
- `release-check`: runs a few sanity checks to know if the distribution is ready to be released
407+
- `release`: releases a new version of the distribution
408+
- `format`: runs python/HTML/XML code formatters on the source code
409+
- `lint`: runs quite some python linters
410+
411+
#### Options
412+
393413
Add the `[tox]` TOML table in `.meta.toml`,
394414
and set the extra configuration for `tox` under the `extra_lines` key.
395415

0 commit comments

Comments
 (0)