Make some pre-commit hooks manual (#263)

Author: blink1073

.github/workflows/tests.yml

@@ -47,6 +47,27 @@ jobs:
         run: |
           codecov
 
+  pre-commit:
+    name: Run pre-commit hook
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - name: Run pre-commit
+        uses: pre-commit/[email protected]
+      - name: Help message if pre-commit fail
+        if: ${{ failure() }}
+        run: |
+          echo "You can install pre-commit hooks to automatically run formatting"
+          echo "on each commit with:"
+          echo "    pre-commit install"
+          echo "or you can run by hand on staged files with"
+          echo "    pre-commit run"
+          echo "or after-the-fact on already committed files with"
+          echo "    pre-commit run --all-files --hook-stage=manual"
+
   docs:
     name: Docs Build
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -1,6 +1,3 @@
-ci:
-  skip: [check-jsonschema]
-
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.1.0
@@ -48,6 +45,7 @@ repos:
     hooks:
       - id: doc8
         args: [--max-line-length=200]
+        stages: [manual]
 
   - repo: https://github.com/pycqa/flake8
     rev: 4.0.1
@@ -59,6 +57,7 @@ repos:
             "flake8-logging-format==0.6.0",
             "flake8-implicit-str-concat==0.2.0",
           ]
+        stages: [manual]
 
   - repo: https://github.com/sirosen/check-jsonschema
     rev: 0.14.2
@@ -68,3 +67,4 @@ repos:
         files: ^\.github/workflows/
         types: [yaml]
         args: ["--schemafile", "https://json.schemastore.org/github-workflow"]
+        stages: [manual]

CONTRIBUTING.md

@@ -62,3 +62,6 @@ If you have already committed files before setting up the pre-commit
 hook with `pre-commit install`, you can fix everything up using
 `pre-commit run --all-files`. You need to make the fixing commit
 yourself after that.
+
+Some of the hooks only run on CI by default, but you can invoke them by
+running with the `--hook-stage manual` argument.