Skip to content

Commit 87184ff

Browse files
committed
feat(docs): explain the tox environments
1 parent 205e68e commit 87184ff

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ When you run this command, it automatically goes through the following steps.
3636
1. It writes the configuration files.
3737
1. It creates a change log entry.
3838
1. By default, it commits changes.
39-
1. It optionally adds packages, pushes commits, or runs tox from the configuration files.
39+
1. It optionally adds packages, pushes commits, or runs tox from the configuration files.
4040

4141
> [!TIP]
4242
> If you prefer to name the new git branch instead of letting the command name it using its default naming scheme, then either create a new branch `my-new-branch`, switch to it, and use the `--branch current` option, or do all that in one step with the `--branch my-new-branch` option.
@@ -432,6 +432,8 @@ _custom configuration_
432432

433433
#### `tox.ini`
434434

435+
##### Testing
436+
435437
Depending on the test runner that you want to use, `plone.meta` will adapt `tox.ini` to it.
436438

437439
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).
@@ -442,6 +444,23 @@ By default, it is set to nothing, that is, the repository's top level is already
442444

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

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

447466
```toml

0 commit comments

Comments
 (0)