Skip to content

Commit 48e66f0

Browse files
Add generate-workflows usage
1 parent 1d8286c commit 48e66f0

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ You can run `tox` with the following arguments:
6868
Python version
6969
* `tox -e spellcheck` to run a spellcheck on all the code
7070
* `tox -e lint-some-package` to run lint checks on `some-package`
71+
* `tox -e generate-workflows` to run creation of new CI workflows if tox environments have been updated
7172
* `tox -e ruff` to run ruff linter and formatter checks against the entire codebase
7273

7374
`ruff check` and `ruff format` are executed when `tox -e ruff` is run. We strongly recommend you to configure [pre-commit](https://pre-commit.com/) locally to run `ruff` automatically before each commit by installing it as git hooks. You just need to [install pre-commit](https://pre-commit.com/#install) in your environment:
@@ -306,6 +307,6 @@ When adding support for a new Python release remember to:
306307

307308
- Add the version in `tox.ini`
308309
- Add the version in `pyproject.toml` trove classifiers
309-
- Update github workflows accordingly; lint and benchmarks use the latest supported version
310+
- Update github workflows accordingly with `tox -e generate-workflows`; lint and benchmarks use the latest supported version
310311
- Update `.pre-commit-config.yaml`
311312
- Update tox examples in the documentation

0 commit comments

Comments
 (0)