Switch to pre-commit for linting

Signed-off-by: John Strunk <[email protected]>

Author: JohnStrunk

.ci-scripts/pre-commit.sh

@@ -11,6 +11,9 @@ ignore: |
   hack/crds/*
   helm/volsync/**
 rules:
+  comments:  # renovate-bot dosen't put 2 spaces before the version number
+    ignore: |
+      .github/workflows/*
   indentation:
     indent-sequences: consistent
   line-length:

.ci-scripts/yamlconfig.yaml

@@ -27,17 +27,26 @@ jobs:
 
     steps:
       - name: Checkout source
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac  # v4.0.0
+        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+
+      - name: Install pre-commit
+        run: |
+          python -m pip install --user pre-commit
+          echo "PYHASH=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
+
+      - name: Enable cache for pre-commit hooks
+        uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3.3.2
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit|${{ env.PYHASH }}|${{ hashFiles('.pre-commit-config.yaml') }}
+          restore-keys: |
+            pre-commit|${{ env.PYHASH }}
+            pre-commit|
 
-      - name: Install prereqs
+      - name: Run pre-commit checks
         run: |
-          echo 'APT::Acquire::Retries "5";' | sudo tee /etc/apt/apt.conf.d/80-retries
-          sudo apt-get update
-          sudo DEBIAN_FRONTEND=noninteractive apt-get install -y python3-pip ruby
-          sudo gem install asciidoctor mdl
-          sudo pip3 install yamllint
-      - name: Run linters
-        run: ./.ci-scripts/pre-commit.sh --require-all
+          pre-commit run -a
+          pre-commit gc
 
   generated-files-check:
     name: Auto Generated Files Check

.github/workflows/operator.yml

@@ -0,0 +1,60 @@
+---
+# yamllint disable rule:line-length
+
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+# Install in your local dev environment
+# > pip install --upgrade --user pre-commit
+# Enable the hooks for this repo
+# > pre-commit install
+
+# Exclude the vendored sources from all checks since we don't control them
+exclude: |
+  (?x)^(
+    mover-restic/minio-go/.*|
+    mover-restic/restic/.*
+  )$
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.4.0"
+    hooks:
+      - id: check-added-large-files  # Prevents giant files from being committed
+      - id: check-json               # Check that JSON files are valid
+      - id: check-merge-conflict     # Check for files that contain merge conflict strings
+      - id: check-symlinks           # Ensure symlinks have a valid target
+      - id: check-toml               # Ensure toml files are valid
+      - id: check-xml                # Check that XML files are valid
+      - id: end-of-file-fixer        # Ensures that a file is either empty, or ends with one newline
+      - id: fix-byte-order-marker    # Forbid utf-8 byte order marker
+      - id: trailing-whitespace      # Trims trailing whitespace
+        args: [--markdown-linebreak-ext=md]
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: "v1.10.0"
+    hooks:
+      - id: rst-backticks
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+
+  - repo: https://github.com/adrienverge/yamllint
+    rev: "v1.32.0"
+    hooks:
+      - id: yamllint
+        args: ["--strict", "-c", ".ci-scripts/yamlconfig.yaml"]
+
+  - repo: https://github.com/jumanjihouse/pre-commit-hooks
+    rev: "3.0.0"
+    hooks:
+      - id: shellcheck
+
+  - repo: https://github.com/markdownlint/markdownlint
+    rev: "v0.12.0"
+    hooks:
+      - id: markdownlint
+        args: ["--style", ".ci-scripts/mdl-style.rb"]
+
+  - repo: https://github.com/renovatebot/pre-commit-hooks
+    rev: "36.78.7"
+    hooks:
+      - id: renovate-config-validator