Merge pull request #31081 from QuLogic/prek

greglucas · web-flow · commit c45ee4a4d472 · 2026-02-05T13:25:54.000-07:00
Switch from pre-commit to prek
diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml
@@ -17,7 +17,7 @@ jobs:
       - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6.2.0
         with:
           python-version: "3.x"
-      - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd  # v3.0.1
+      - uses: j178/prek-action@564dda4cfa5e96aafdc4a5696c4bf7b46baae5ac  # v1.1.0
         with:
           extra_args: --hook-stage manual --all-files
 
diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst
@@ -322,7 +322,7 @@ you are aware of the existing issues beforehand.
 
 Install pre-commit hooks
 ========================
-`pre-commit <https://pre-commit.com/>`_ hooks save time in the review process by
+`prek <https://prek.j178.dev/>`_ hooks save time in the review process by
 identifying issues with the code before a pull request is formally opened. Most
 hooks can also aide in fixing the errors, and the checks should have
 corresponding :ref:`development workflow <development-workflow>` and
@@ -333,8 +333,8 @@ committed files, import order, and incorrect branching.
 
 Install pre-commit hooks ::
 
-    python -m pip install pre-commit
-    pre-commit install
+    python -m pip install prek
+    prek install
 
 Hooks are run automatically after the ``git commit`` stage of the
 :ref:`editing workflow<edit-flow>`. When a hook has found and fixed an error in a
@@ -343,11 +343,11 @@ file, that file must be *staged and committed* again.
 Hooks can also be run manually. All the hooks can be run, in order as
 listed in ``.pre-commit-config.yaml``, against the full codebase with ::
 
-    pre-commit run --all-files
+    prek run --all-files
 
-To run a particular hook manually, run ``pre-commit run`` with the hook id ::
+To run a particular hook manually, run ``prek run`` with the hook id ::
 
-    pre-commit run <hook id> --all-files
+    prek run <hook id> --all-files
 
 
 Please note that the ``mypy`` pre-commit hook cannot check the :ref:`type-hints`
diff --git a/doc/devel/pr_guide.rst b/doc/devel/pr_guide.rst
@@ -56,7 +56,7 @@ When opening a pull request on Github, please ensure that:
 
 * Changes were made on a :ref:`feature branch <make-feature-branch>`.
 
-* :ref:`pre-commit <pre-commit-hooks>` checks for spelling, formatting, etc pass
+* :ref:`prek <pre-commit-hooks>` checks for spelling, formatting, etc pass
 
 * The pull request targets the :ref:`main branch <pr-branch-selection>`
 
diff --git a/environment.yml b/environment.yml
@@ -61,7 +61,7 @@ dependencies:
   - nbformat!=5.0.0,!=5.0.1
   - pandas!=0.25.0
   - psutil
-  - pre-commit
+  - prek
   - pydocstyle>=5.1.0
   - pytest!=4.6.0,!=5.4.0,!=8.1.0
   - pytest-cov
