Merge pull request #422 from lincc-frameworks/issue/410/consolidate-p…

…re-commit

Consolidate pre-commit logic

python-project-template/.github/workflows/pre-commit-ci.yml.jinja

@@ -1,17 +1,17 @@
-# This workflow runs pre-commit hooks on pull requests to enforce coding style.
-# To ensure correct configuration, please refer to:
-#   https://lincc-ppt.readthedocs.io/en/latest/practices/ci_precommit.html
-
+# This workflow runs pre-commit hooks on pushes and pull requests to main
+# to enforce coding style. To ensure correct configuration, please refer to:
+#  https://lincc-ppt.readthedocs.io/en/latest/practices/ci_precommit.html
 name: Run pre-commit hooks
 
 on:
+  push:
+    branches: [ main ]
   pull_request:
+    branches: [ main ]
 
 jobs:
   pre-commit-ci:
     runs-on: ubuntu-latest
-    env: 
-      SKIP: "check-lincc-frameworks-template-version,pytest-check,no-commit-to-branch,validate-pyproject,check-added-large-files,sphinx-build"
     steps:
     - uses: actions/checkout@v4
       with:
@@ -28,6 +28,8 @@ jobs:
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - uses: pre-commit/[email protected]
       with:
-        extra_args: --from-ref {% raw %}${{ github.event.pull_request.base.sha }}{% endraw %} --to-ref {% raw %}${{ github.event.pull_request.head.sha }}{% endraw %}
+        extra_args: --all-files --verbose
+      env:
+        SKIP: "check-lincc-frameworks-template-version,no-commit-to-branch,check-added-large-files,validate-pyproject,sphinx-build,pytest-check"
     - uses: pre-commit-ci/[email protected]
-      if: always()
+      if: failure() && github.event_name == 'pull_request' && github.event.pull_request.draft == false

python-project-template/.pre-commit-config.yaml.jinja

@@ -1,4 +1,3 @@
-fail_fast: true
 repos:
     # Compare the local template version to the latest remote template version
     # This hook should always pass. It will print a message if the local version 
@@ -132,20 +131,6 @@ repos:
           {%- endif %}
           ]
 {%- endif %}
-    # Run unit tests, verify that they pass. Note that coverage is run against
-    # the ./src directory here because that is what will be committed. In the 
-    # github workflow script, the coverage is run against the installed package
-    # and uploaded to Codecov by calling pytest like so:
-    # `python -m pytest --cov=<package_name> --cov-report=xml`
-  - repo: local
-    hooks:
-      - id: pytest-check
-        name: Run unit tests
-        description: Run unit tests with pytest.
-        entry: bash -c "if python -m pytest --co -qq; then python -m pytest --cov=./src --cov-report=html; fi"
-        language: system
-        pass_filenames: false
-        always_run: true
 {%- if include_notebooks %}
     # Make sure Sphinx can build the documentation while explicitly omitting 
     # notebooks from the docs, so users don't have to wait through the execution 
@@ -195,3 +180,17 @@ repos:
             "./_readthedocs", # Output directory for rendered documents.
           ]
 {%- endif %}
+    # Run unit tests, verify that they pass. Note that coverage is run against
+    # the ./src directory here because that is what will be committed. In the
+    # github workflow script, the coverage is run against the installed package
+    # and uploaded to Codecov by calling pytest like so:
+    # `python -m pytest --cov=<package_name> --cov-report=xml`
+  - repo: local
+    hooks:
+      - id: pytest-check
+        name: Run unit tests
+        description: Run unit tests with pytest.
+        entry: bash -c "if python -m pytest --co -qq; then python -m pytest --cov=./src --cov-report=html; fi"
+        language: system
+        pass_filenames: false
+        always_run: true