Skip to content

Commit 66a6780

Browse files
Add generate-workflows usage to CONTRIBUTING (open-telemetry#2977)
1 parent bf8e281 commit 66a6780

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

CONTRIBUTING.md

Lines changed: 3 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:
@@ -297,6 +298,7 @@ When updating the minimum supported Python version remember to:
297298

298299
- Remove the version in `pyproject.toml` trove classifiers
299300
- Remove the version from `tox.ini`
301+
- Update github workflows accordingly with `tox -e generate-workflows`
300302
- Search for `sys.version_info` usage and remove code for unsupported versions
301303
- Bump `py-version` in `.pylintrc` for Python version dependent checks
302304

@@ -306,6 +308,6 @@ When adding support for a new Python release remember to:
306308

307309
- Add the version in `tox.ini`
308310
- Add the version in `pyproject.toml` trove classifiers
309-
- Update github workflows accordingly; lint and benchmarks use the latest supported version
311+
- Update github workflows accordingly with `tox -e generate-workflows`; lint and benchmarks use the latest supported version
310312
- Update `.pre-commit-config.yaml`
311313
- Update tox examples in the documentation

0 commit comments

Comments
 (0)