pre-commit: move logic for applying patch to shell script

Author: berquist

.github/workflows/pre-commit.yml

@@ -18,13 +18,4 @@ jobs:
       - uses: pre-commit/action@v3.0.1
       - run: |
           python -m pip install 'ruamel.yaml'
-          if ! python sort_regressionfiles_yaml.py > regressionfiles.diff; then
-              echo "difference found:"
-              cat regressionfiles.diff
-              if ! patch -p1 -i regressionfiles.diff regressionfiles.yaml; then
-                  echo "patch didn't apply cleanly"
-              else
-                  echo "patch applied cleanly"
-              fi
-              exit 1
-          fi
+          ./sort_regressionfiles_yaml.sh

sort_regressionfiles_yaml.py

@@ -1,5 +1,12 @@
 #!/usr/bin/env python
 
+"""sort_regressionfiles_yaml.py: Check and see if the entries in
+regressionfiles.yaml are sorted by filename, producing the diff to standard
+out that should make them sorted.
+
+You should probably call the shell script, which wraps this Python code.
+"""
+
 
 if __name__ == "__main__":
     import sys
@@ -16,6 +23,10 @@
 
     contents_sorted = {"regressions": sorted(contents["regressions"], key=lambda x: x["loc_entry"])}
 
+    # Since the original regressionfiles.yaml has comments, we need to strip
+    # those out before generating the diff, since we can't yet generated
+    # sorted output that contains comments.
+
     with open("regressionfiles_nocomments.yaml", "w", encoding="utf-8") as handle:
         yaml.dump(contents, handle)
 
@@ -24,9 +35,8 @@
 
     result = sp.run(
         [
-            "git",
             "diff",
-            "--no-index",
+            "-u",
             "regressionfiles_nocomments.yaml",
             "regressionfiles_sorted.yaml",
         ]

sort_regressionfiles_yaml.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -euo pipefail
+
+# sort_regressionfiles_yaml.sh: Check and see if the entries in
+# regressionfiles.yaml are sorted by filename, producing a diff file that
+# should make them sorted.  Then, attempt to apply the diff as a patch that
+# would make regressionfiles.yaml sorted, which may fail depending on any
+# comments present in the original file.
+#
+# You should probably call this shell script and not the Python code.
+
+if ! python sort_regressionfiles_yaml.py > regressionfiles.diff; then
+    echo "difference found:"
+    cat regressionfiles.diff
+    if ! patch -p1 -i regressionfiles.diff regressionfiles.yaml; then
+        echo "patch didn't apply cleanly"
+    else
+        echo "patch applied cleanly"
+    fi
+    exit 1
+fi