Skip to content

Commit 6c145a5

Browse files
committed
tox -e ruff -> tox -e precommit
But keep the old name for compat
1 parent cfe43eb commit 6c145a5

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

.github/workflows/misc_0.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,8 @@ jobs:
157157
- name: Run tests
158158
run: tox -e shellcheck
159159

160-
ruff:
161-
name: ruff
160+
precommit:
161+
name: precommit
162162
runs-on: ubuntu-latest
163163
timeout-minutes: 30
164164
steps:
@@ -174,7 +174,7 @@ jobs:
174174
run: pip install tox-uv
175175

176176
- name: Run tests
177-
run: tox -e ruff
177+
run: tox -e precommit
178178

179179
typecheck:
180180
name: typecheck

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ You can run `tox` with the following arguments:
8484
* `tox -e lint-some-package` to run lint checks on `some-package`
8585
* `tox -e generate-workflows` to run creation of new CI workflows if tox environments have been updated
8686
* `tox -e ruff` to run ruff linter and formatter checks against the entire codebase
87+
* `tox -e precommit` to run all `pre-commit` actions
8788

8889
`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` and `rstcheck` 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:
8990

tox.ini

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ envlist =
429429
generate
430430
generate-workflows
431431
shellcheck
432-
ruff
432+
precommit
433433
typecheck
434434

435435
[testenv]
@@ -1047,7 +1047,7 @@ commands_pre =
10471047
commands =
10481048
sh -c "find {toxinidir} -name \*.sh | xargs shellcheck --severity=warning"
10491049

1050-
[testenv:ruff]
1050+
[testenv:{precommit,ruff}]
10511051
basepython: python3
10521052
deps =
10531053
-c {toxinidir}/dev-requirements.txt

0 commit comments

Comments
 (0)