Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,8 @@ _custom configuration_

#### `tox.ini`

##### Testing

Depending on the test runner that you want to use, `plone.meta` will adapt `tox.ini` to it.

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).
Expand All @@ -435,6 +437,23 @@ By default, it is set to nothing, that is, the repository's top level is already

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

##### Environments

`plone/meta` generates the following `tox` environments:

- `init`: prepares the environment (only if `mxdev` is used)
- `test`: runs the package's python tests
- `coverage`: runs the package's python tests and generates a coverage report out of it
- `dependencies`: checks that all python dependencies are specified properly
- `dependencies-graph`: generates a graph to visualize the dependencies tree/forest
- `circular`: checks that within the dependency graph there are no circular imports
- `release-check`: runs a few sanity checks to know if the distribution is ready to be released
- `release`: releases a new version of the distribution
- `format`: runs python/HTML/XML code formatters on the source code
- `lint`: runs quite some python linters

##### Options

Add the `[tox]` TOML table in `.meta.toml`, and set the extra configuration for `tox` under the `extra_lines` key.

```toml
Expand Down
9 changes: 9 additions & 0 deletions src/plone/meta/default/tox.ini.j2
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,12 @@ envlist =
# _your own configuration lines_
# """
##

[testenv:release]
description = create a new release
skip_install = true
deps =
zest.release[recommended]
-c %(constraints_file)s
commands =
fullrelease