pre-commit: ensure regressionfiles.yaml is sorted

Author: berquist

.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+---
+name: ci
+
+# yamllint disable-line rule:truthy
+on:
+  push:
+  pull_request:
+
+concurrency:
+  group: ci-${{github.ref}}-${{github.event.pull_request.number || github.run_number}}
+  cancel-in-progress: true
+
+jobs:
+  prechecks:
+    uses: ./.github/workflows/pre-commit.yml
+  all-prechecks:
+    needs: [prechecks]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Success
+        run: "true"

.github/workflows/pre-commit.yml

@@ -0,0 +1,21 @@
+---
+name: pre-commit
+
+# yamllint disable-line rule:truthy
+on:
+  workflow_call:
+
+concurrency:
+  group: style-${{github.ref}}-${{github.event.pull_request.number || github.run_number}}
+  cancel-in-progress: true
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      - uses: pre-commit/action@v3.0.1
+      - run: |
+          python -m pip install 'ruamel.yaml'
+          python sort_regressionfiles_yaml.py

.pre-commit-config.yaml

@@ -9,10 +9,3 @@ repos:
     rev: "v5.0.0"
     hooks:
       - id: check-yaml
-  - repo: local
-    hooks:
-      - id: sort-regressionfiles-yaml
-        name: Sort regressionfiles.yaml
-        entry: ./sort_regressionfiles_yaml.sh
-        language: script
-        files: ^regressionfiles\.yaml$

sort_regressionfiles_yaml.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+
+
+if __name__ == "__main__":
+    import sys
+    import subprocess as sp
+
+    from ruamel.yaml import YAML
+
+    yaml = YAML(pure=True, typ="safe")
+    yaml.default_flow_style = False
+    yaml.indent(mapping=2, sequence=4, offset=2)
+
+    with open("regressionfiles.yaml", encoding="utf-8") as handle:
+        contents = yaml.load(handle)
+
+    contents_sorted = {"regressions": sorted(contents["regressions"], key=lambda x: x["loc_entry"])}
+
+    with open("regressionfiles_nocomments.yaml", "w", encoding="utf-8") as handle:
+        yaml.dump(contents, handle)
+
+    with open("regressionfiles_sorted.yaml", "w", encoding="utf-8") as handle:
+        yaml.dump(contents_sorted, handle)
+
+    result = sp.run(
+        [
+            "git",
+            "diff",
+            "--no-index",
+            "regressionfiles_nocomments.yaml",
+            "regressionfiles_sorted.yaml",
+        ]
+    )
+    if result.returncode:
+        sys.exit(result.returncode)