Skip to content

Commit 0875af5

Browse files
authored
Merge pull request #2041 from sydduckworth/replace-precommit-with-prek
Replace `pre-commit` with `prek`
2 parents e27c5c0 + 09f2382 commit 0875af5

3 files changed

Lines changed: 7 additions & 9 deletions

File tree

.github/pull_request_template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ Thanks for contributing to asdf!
44
Your PR should trigger the CI (after approval for first-time contributors)
55
which will:
66
7-
- check your code for 'style' using pre-commit
7+
- check your code for 'style' using prek
88
- run your PR against the asdf unit tests for various OSes, python versions, and dependency versions
99
- perform a test build of your PR
1010
1111
It is highly recommended that you run some of these tests locally by:
1212
13-
- [installing pre-commit](https://pre-commit.com/#quick-start)
13+
- [installing prek](https://prek.j178.dev/quickstart/)
1414
- [running pytest](https://docs.pytest.org/en/7.1.x/getting-started.html)
1515
1616
This will increase the chances your PR will pass the required CI tests.
@@ -27,7 +27,7 @@ If this PR fixes an issue, please add closing keywords (eg 'fixes #XXX')
2727

2828
## Tasks
2929

30-
- [ ] [run `pre-commit` on your machine](https://pre-commit.com/#quick-start)
30+
- [ ] [run `prek` on your machine](https://prek.j178.dev/quickstart/)
3131
- [ ] run `pytest` on your machine
3232
- [ ] Does this PR add new features and / or change user-facing code / API? (if not, label with `no-changelog-entry-needed`)
3333
- [ ] write news fragment(s) in `changes/`: `echo "changed something" > changes/<PR#>.<changetype>.rst` (see below for change types)

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
steps:
3333
- uses: actions/checkout@v6
3434
- uses: actions/setup-python@v6
35-
- uses: pre-commit/action@v3.0.1
35+
- uses: j178/prek-action@v2
3636
type-checking:
3737
runs-on: ubuntu-latest
3838
steps:

CONTRIBUTING.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,9 @@ to the maintainers, who are glad to assist you.
4242
you run these tools regularly on your code to ensure that it is formatted
4343
correctly.
4444

45-
To make this easier, we have included `pre-commit <https://pre-commit.com/>`__
46-
support for ASDF. We suggest that you install ``pre-commit``, so that your
47-
code is automatically formatted before you commit. For those who do not run
48-
these tools regularly, the ``pre-commit-ci`` bot will attempt to fix the issues
49-
with your pull request when you submit it.
45+
To make this easier, we have included `prek <https://prek.j178.dev/>`__
46+
support for ASDF. We suggest that you install ``prek`` (or ``precommit``) so that your
47+
code is automatically formatted before you commit.
5048

5149
.. note::
5250
Backporting changes is done automatically using ``meeseeksdev``. If you are

0 commit comments

Comments
 (0)