From a5d219ed05724ec015bfa90c23f883d6002e7902 Mon Sep 17 00:00:00 2001 From: Ludy Date: Fri, 1 Aug 2025 18:21:28 +0200 Subject: [PATCH] chore(pre-commit): enable test source formatting and build validation on push to main (#4067) # Description of Changes This PR improves the pre-commit workflow and formatting configuration to enforce consistency and catch issues earlier in CI: - **Pre-commit workflow (`pre_commit.yml`)**: - Trigger now runs on `push` to `main` (previously scheduled weekly only). - Adds a `gradlew clean build` step to ensure the codebase compiles as part of the pre-commit validation. - Configures Java 17 using the Temurin distribution via `actions/setup-java`. - **.pre-commit-config.yaml**: - Updated `ruff` to version `v0.12.7` (from `v0.12.0`). - Updated `gitleaks` to `v8.28.0` (from `v8.27.2`). - **Spotless configuration**: - Added formatting for `test` sources across all Gradle modules (`common`, `core`, `proprietary`, `stirling-pdf`). - Ensures that test code follows the same formatting rules as production code. These changes help improve early feedback in development and CI by integrating linting, formatting, and build checks directly into the workflow on code pushes. --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [x] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [ ] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing) for more details. --- .github/workflows/pre_commit.yml | 14 ++++++++++++-- .pre-commit-config.yaml | 4 ++-- app/common/build.gradle | 1 + app/core/build.gradle | 1 + app/proprietary/build.gradle | 1 + build.gradle | 4 ++++ 6 files changed, 21 insertions(+), 4 deletions(-) diff --git a/.github/workflows/pre_commit.yml b/.github/workflows/pre_commit.yml index c4697a965..6560e9226 100644 --- a/.github/workflows/pre_commit.yml +++ b/.github/workflows/pre_commit.yml @@ -2,8 +2,9 @@ name: Pre-commit on: workflow_dispatch: - schedule: - - cron: "0 0 * * 1" + push: + branches: + - main permissions: contents: read @@ -46,6 +47,15 @@ jobs: - run: pre-commit run --all-files -c .pre-commit-config.yaml continue-on-error: true + - name: Set up JDK + uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1 + with: + java-version: 17 + distribution: "temurin" + + - name: Build with Gradle + run: ./gradlew clean build + - name: git add run: | git add . diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index ec2d837e2..e1de0c28b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ repos: - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.12.0 + rev: v0.12.7 hooks: - id: ruff args: @@ -22,7 +22,7 @@ repos: files: \.(html|css|js|py|md)$ exclude: (.vscode|.devcontainer|app/core/src/main/resources|app/proprietary/src/main/resources|Dockerfile|.*/pdfjs.*|.*/thirdParty.*|bootstrap.*|.*\.min\..*|.*diff\.js) - repo: https://github.com/gitleaks/gitleaks - rev: v8.27.2 + rev: v8.28.0 hooks: - id: gitleaks - repo: https://github.com/pre-commit/pre-commit-hooks diff --git a/app/common/build.gradle b/app/common/build.gradle index 3c46a59af..515a52a5c 100644 --- a/app/common/build.gradle +++ b/app/common/build.gradle @@ -5,6 +5,7 @@ bootRun { spotless { java { target sourceSets.main.allJava + target sourceSets.test.allJava googleJavaFormat(googleJavaFormatVersion).aosp().reorderImports(false) importOrder("java", "javax", "org", "com", "net", "io", "jakarta", "lombok", "me", "stirling") diff --git a/app/core/build.gradle b/app/core/build.gradle index d37ee9354..46aad111c 100644 --- a/app/core/build.gradle +++ b/app/core/build.gradle @@ -15,6 +15,7 @@ configurations { spotless { java { target sourceSets.main.allJava + target sourceSets.test.allJava googleJavaFormat(googleJavaFormatVersion).aosp().reorderImports(false) importOrder("java", "javax", "org", "com", "net", "io", "jakarta", "lombok", "me", "stirling") diff --git a/app/proprietary/build.gradle b/app/proprietary/build.gradle index 2a72f8a65..467d8a138 100644 --- a/app/proprietary/build.gradle +++ b/app/proprietary/build.gradle @@ -7,6 +7,7 @@ bootRun { spotless { java { target sourceSets.main.allJava + target sourceSets.test.allJava googleJavaFormat(googleJavaFormatVersion).aosp().reorderImports(false) importOrder("java", "javax", "org", "com", "net", "io", "jakarta", "lombok", "me", "stirling") diff --git a/build.gradle b/build.gradle index 7ec5d4e3c..ceb786ff0 100644 --- a/build.gradle +++ b/build.gradle @@ -530,9 +530,13 @@ launch4j { spotless { java { target sourceSets.main.allJava + target sourceSets.test.allJava target project(':common').sourceSets.main.allJava + target project(':common').sourceSets.test.allJava target project(':proprietary').sourceSets.main.allJava + target project(':proprietary').sourceSets.test.allJava target project(':stirling-pdf').sourceSets.main.allJava + target project(':stirling-pdf').sourceSets.test.allJava googleJavaFormat(googleJavaFormatVersion).aosp().reorderImports(false)