feat: enhance pre-commit workflow with improved caching and cross-platform support

Author: Bit-Maximum

.github/workflows/pre-commit.yml

@@ -2,59 +2,94 @@ name: Lint with Pre-commit
 
 on:
   push:
-    branches: [master, main]
+    branches: [master, main, develop]
   pull_request:
-    branches: [master, main]
+    branches: [master, main, develop]
 
 jobs:
-  gradle-code-quality:
-    name: Gradle Code Quality
+  pre-commit-checks:
+    name: Pre-commit Checks (JDK ${{ matrix.java-version }})
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
         java-version: [21, 25]
+      fail-fast: false
 
     permissions:
       contents: read
       pull-requests: write
+      checks: write
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
 
       - name: Set up JDK ${{ matrix.java-version }}
         uses: actions/setup-java@v5
         with:
           distribution: temurin
           java-version: ${{ matrix.java-version }}
+          cache: gradle
 
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v5
         with:
           build-scan-publish: true
           build-scan-terms-of-use-url: "https://gradle.com/help/legal-terms-of-use"
           build-scan-terms-of-use-agree: "yes"
+          cache-read-only: ${{ github.ref != 'refs/heads/main' && github.ref != 'refs/heads/master' }}
+
+      - name: Cache pre-commit environments
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/pre-commit
+            ~/.local/share/pre-commit
+          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}-${{ runner.os }}
+          restore-keys: |
+            pre-commit-${{ runner.os }}
 
-      - name: Set up Python (for pre-commit)
+      - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: '3.13'
+          cache: 'pip'
 
       - name: Install pre-commit
         run: pip install pre-commit
 
+      - name: Make gradlew executable
+        run: chmod +x ./gradlew
+
       - name: Run pre-commit hooks
         id: precommit
+        continue-on-error: false
         run: |
-          chmod +x ./gradlew
-          pre-commit run --all-files --show-diff-on-failure --color always
+          set -e  # Exit immediately on error
+          echo "Running pre-commit checks..."
+          pre-commit run --all-files --show-diff-on-failure --color=always --verbose
 
-      - name: Upload reports
-        if: always()
-        uses: actions/upload-artifact@v4
+      - name: Comment on PR with results
+        if: github.event_name == 'pull_request' && always()
+        uses: actions/github-script@v7
         with:
-          name: reports-jdk-${{ matrix.java-version }}
-          path: |
-            build/reports/
-            **/build/reports/
+          script: |
+            const result = '${{ steps.precommit.outcome }}';
+            if (result === 'failure') {
+              github.rest.issues.createComment({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: `❌ Pre-commit checks failed for JDK ${{ matrix.java-version }}. Please check the workflow run for details.`
+              });
+            } else if (result === 'success') {
+              github.rest.issues.createComment({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: `✅ Pre-commit checks passed for JDK ${{ matrix.java-version }}!`
+              });
+            }

.pre-commit-config.yaml

@@ -16,32 +16,19 @@ repos:
       - id: trailing-whitespace
 
   # -------------------------
-  # 2. Linting - Spotless
-  # -------------------------
-  - repo: local
-    hooks:
-      - id: spotless-check
-        name: Gradle Spotless (format checker)
-        entry: bash -c "./gradlew spotlessCheck"
-        language: system
-        types: [java]
-        pass_filenames: false
-
-      - id: spotless-apply
-        name: Gradle Spotless (auto format)
-        entry: bash -c "./gradlew spotlessApply"
-        language: system
-        types: [java]
-        pass_filenames: false
-
-  # -------------------------
-  # 3. Java - Check Code quality
+  # 2. Java - Check Code quality
   # -------------------------
   - repo: local
     hooks:
       - id: code-quality
-        name: Gradle Code Quality (Spotless + Checkstyle + SpotBugs + PMD)
-        entry: bash -c "./gradlew codeQuality"
+        name: Gradle Code Quality
+        entry: python
+        args:
+          - -c
+          - |
+            import os, subprocess, sys
+            cmd = 'gradlew.bat' if os.name == 'nt' else './gradlew'
+            sys.exit(subprocess.run([cmd, 'codeQuality']).returncode)
         language: system
-        types: [java]
         pass_filenames: false
+        always_run: true