Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release distribution #192

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
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
20 changes: 20 additions & 0 deletions config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,9 @@ _custom configuration_

### `tox.ini`


#### Testing

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

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

If either a `tests` or `src` folder exists, then they are used as a 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.

Expand Down
9 changes: 9 additions & 0 deletions config/default/tox.ini.j2
Original file line number Diff line number Diff line change
Expand Up @@ -313,3 +313,12 @@ commands =
# _your own configuration lines_
# """
##

[testenv:release]
description = create a new release
skip_install = true
deps =
zest.release[recommended]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in zest.releaser. And we should add two that are not in the recommended list:

Suggested change
zest.release[recommended]
zest.releaser[recommended]
zest.pocompile
zestreleaser.towncrier

-c %(constraints_file)s
commands =
fullrelease