Skip to content

Commit a372ce8

Browse files
committed
feat(docs): explain the tox environments
1 parent c0da3e3 commit a372ce8

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -425,6 +425,8 @@ _custom configuration_
425425

426426
#### `tox.ini`
427427

428+
##### Testing
429+
428430
Depending on the test runner that you want to use, `plone.meta` will adapt `tox.ini` to it.
429431

430432
In the `[tox]` TOML table in `.meta.toml`, set the value for the key `test_runner` to `pytest` if you want to use [`pytest`](https://pypi.org/project/pytest).
@@ -435,6 +437,23 @@ By default, it is set to nothing, that is, the repository's top level is already
435437

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

440+
##### Environments
441+
442+
`plone/meta` generates the following `tox` environments:
443+
444+
- `init`: prepares the environment (only if `mxdev` is used)
445+
- `test`: runs the package's python tests
446+
- `coverage`: runs the package's python tests and generates a coverage report out of it
447+
- `dependencies`: checks that all python dependencies are specified properly
448+
- `dependencies-graph`: generates a graph to visualize the dependencies tree/forest
449+
- `circular`: checks that within the dependency graph there are no circular imports
450+
- `release-check`: runs a few sanity checks to know if the distribution is ready to be released
451+
- `release`: releases a new version of the distribution
452+
- `format`: runs python/HTML/XML code formatters on the source code
453+
- `lint`: runs quite some python linters
454+
455+
##### Options
456+
438457
Add the `[tox]` TOML table in `.meta.toml`, and set the extra configuration for `tox` under the `extra_lines` key.
439458

440459
```toml

0 commit comments

Comments
 (0)