Skip to content
Draft
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
2 changes: 1 addition & 1 deletion .github/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
-r ../test/requirements-dev.txt

pre-commit>=3.2.0
prek>=0.3.8
6 changes: 3 additions & 3 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ jobs:
test/requirements*.txt
- uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5.0.3
with:
path: ~/.cache/pre-commit
key: pre-commit-${{hashFiles('.pre-commit-config.yaml')}}
path: ~/.cache/prek
key: prek-${{hashFiles('.pre-commit-config.yaml')}}
- name: Install dependencies
run: |
python3 -m venv venv # for venv-run
Expand All @@ -34,7 +34,7 @@ jobs:
- name: Run pre-commit checks
run: |
source venv/bin/activate
pre-commit run --color=always --all-files --show-diff-on-failure
prek run --color=always --all-files --show-diff-on-failure

distcheck:
runs-on: ubuntu-latest
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,14 +226,14 @@ Also, please bear the following coding guidelines in mind:
python3 -m pip install -r test/requirements-dev.txt
```

- Install pre-commit and set it up, see <https://pre-commit.com/>.
- Install prek and set it up, see <https://prek.j178.dev>.
That'll run a bunch of linters and the like, the same as the
bash-completion CI does. Running it locally and fixing found issues before
commit/push/PR reduces some roundtrips with the review.
After installing it, enable it for stages we use it with like:

```shell
pre-commit install --hook-type pre-commit --hook-type commit-msg
prek install --hook-type pre-commit --hook-type commit-msg
```

- File bugs, enhancement, and pull requests at GitHub,
Expand Down
Loading