Enforce code style

.github/workflows/codestyle.yml

@@ -0,0 +1,111 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: "Code Style"
+on:
+  push:
+    branches:
+      - '[0-9]+.[0-9]+.x'
+  pull_request:
+  workflow_dispatch:
+# queue jobs and only allow 1 run per branch due to the likelihood of hitting GitHub resource limits
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
+jobs:
+  check_core_projects:
+    name: "Core Projects"
+    runs-on: ubuntu-24.04
+    steps:
+      - name: "🌐 Output Agent IP" # in the event RAO blocks this agent, this can be used to debug it
+        run: curl -s https://api.ipify.org
+      - name: "📥 Checkout repository"
+        uses: actions/checkout@v4
+      - name: "☕️ Setup JDK"
+        uses: actions/setup-java@v4
+        with:
+          distribution: liberica
+          java-version: 17
+      - name: "🐘 Setup Gradle"
+        uses: gradle/actions/setup-gradle@v4
+        with:
+          develocity-access-key: ${{ secrets.GRAILS_DEVELOCITY_ACCESS_KEY }}
+      - name: "🔎 Check Core Projects"
+        run: ./gradlew codeStyle
+      - name: "📤 Upload Failure Reports"
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: core-reports
+          path: |
+            **/build/reports/checkstyle/
+            **/build/reports/codenarc/
+  check_gradle_plugin_projects:
+    name: "Gradle Plugin Projects"
+    runs-on: ubuntu-24.04
+    steps:
+      - name: "🌐 Output Agent IP" # in the event RAO blocks this agent, this can be used to debug it
+        run: curl -s https://api.ipify.org
+      - name: "📥 Checkout repository"
+        uses: actions/checkout@v4
+      - name: "☕️ Setup JDK"
+        uses: actions/setup-java@v4
+        with:
+          distribution: liberica
+          java-version: 17
+      - name: "🐘 Setup Gradle"
+        uses: gradle/actions/setup-gradle@v4
+        with:
+          develocity-access-key: ${{ secrets.GRAILS_DEVELOCITY_ACCESS_KEY }}
+      - name: "🔎 Check Gradle Plugin Projects"
+        working-directory: grails-gradle
+        run: ./gradlew codeStyle
+      - name: "📤 Upload Failure Reports"
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: gradle-plugin-reports
+          path: |
+            grails-gradle/**/build/reports/checkstyle/
+            grails-gradle/**/build/reports/codenarc/
+  check_grails_forge_projects:
+    name: "Forge Projects"
+    runs-on: ubuntu-24.04
+    steps:
+      - name: "🌐 Output Agent IP" # in the event RAO blocks this agent, this can be used to debug it
+        run: curl -s https://api.ipify.org
+      - name: "📥 Checkout repository"
+        uses: actions/checkout@v4
+      - name: "☕️ Setup JDK"
+        uses: actions/setup-java@v4
+        with:
+          distribution: liberica
+          java-version: 17
+      - name: "🐘 Setup Gradle"
+        uses: gradle/actions/setup-gradle@v4
+        with:
+          develocity-access-key: ${{ secrets.GRAILS_DEVELOCITY_ACCESS_KEY }}
+      - name: "🔎 Check Forge Projects"
+        working-directory: grails-forge
+        run: ./gradlew codeStyle
+      - name: "📤 Upload Failure Reports"
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: forge-reports
+          path: |
+            grails-forge/**/build/reports/checkstyle/
+            grails-forge/**/build/reports/checkstyleNohttp/
+            grails-forge/**/build/reports/codenarc/

.github/workflows/gradle.yml

@@ -51,14 +51,19 @@ jobs:
         working-directory: 'grails-gradle'
         run: >
           ./gradlew build
-          --continue --stacktrace -PskipTests
+          --continue
+          --stacktrace
+          -PskipCodeStyle
+          -PskipTests
       - name: "🔨 Build project with tests"
         if: ${{ !contains(github.event.head_commit.message, '[skip tests]') }}
         working-directory: 'grails-gradle'
         run: >
           ./gradlew build
-          --continue --stacktrace
+          --continue
+          --stacktrace
           --rerun-tasks
+          -PskipCodeStyle
   build:
     if: ${{ !contains(github.event.head_commit.message, '[skip tests]') }}
     name: 'Build Grails-Core'
@@ -85,8 +90,11 @@ jobs:
       - name: "🔨 Build project"
         run: >
           ./gradlew build :grails-shell-cli:installDist groovydoc
-          --continue --stacktrace -PonlyCoreTests
+          --continue
           --rerun-tasks
+          --stacktrace
+          -PonlyCoreTests
+          -PskipCodeStyle
   buildForge:
     name: "Build Grails Forge"
     strategy:
@@ -113,14 +121,19 @@ jobs:
         working-directory: 'grails-forge'
         run: >
           ./gradlew build
-          --continue --stacktrace -PskipTests
+          --continue
+          --stacktrace
+          -PskipCodeStyle
+          -PskipTests
       - name: "🔨 Build project with tests"
         if: ${{ !contains(github.event.head_commit.message, '[skip tests]') }}
         working-directory: 'grails-forge'
         run: >
           ./gradlew build
-          --continue --stacktrace
+          --continue
           --rerun-tasks
+          --stacktrace
+          -PskipCodeStyle
       - name: "✅ Verify combined CLI"
         run: |
           cd grails-forge
@@ -162,11 +175,13 @@ jobs:
       - name: "🏃 Run Functional Tests"
         run: >
           ./gradlew bootJar check
-          --continue --stacktrace
+          --continue
+          --rerun-tasks
+          --stacktrace
           -PonlyFunctionalTests
+          -PskipCodeStyle
           -PskipHibernate5Tests
           -PskipMongodbTests
-          --rerun-tasks
   mongodbFunctional:
     if: ${{ !contains(github.event.head_commit.message, '[skip tests]') }}
     name: "Mongodb Functional Tests"
@@ -195,10 +210,12 @@ jobs:
           GITHUB_MAVEN_PASSWORD: ${{ secrets.GITHUB_TOKEN }}
         run: >
           ./gradlew bootJar cleanTest check
-          --continue --stacktrace
+          --continue
+          --rerun-tasks
+          --stacktrace
           -PonlyMongodbTests
           -PmongodbContainerVersion=${{ matrix.mongodb-version }}
-          --rerun-tasks
+          -PskipCodeStyle
   hibernate5Functional:
     if: ${{ !contains(github.event.head_commit.message, '[skip tests]') }}
     name: "Hibernate5 Functional Tests"
@@ -226,9 +243,11 @@ jobs:
           GITHUB_MAVEN_PASSWORD: ${{ secrets.GITHUB_TOKEN }}
         run: >
           ./gradlew bootJar cleanTest check
-          --continue --stacktrace
-          -PonlyHibernate5Tests
+          --continue
           --rerun-tasks
+          --stacktrace
+          -PonlyHibernate5Tests
+          -PskipCodeStyle
   publishGradle:
     if: github.repository_owner == 'apache' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch')
     needs: [ buildGradle ]
@@ -256,7 +275,8 @@ jobs:
         working-directory: 'grails-gradle'
         run: >
           ./gradlew publish aggregateChecksums aggregatePublishedArtifacts
-          -Dorg.gradle.internal.publish.checksums.insecure=true --no-build-cache --rerun-tasks
+          --no-build-cache
+          --rerun-tasks
       - name: "📤 Upload grails-gradle checksums"
         uses: actions/upload-artifact@v4
         with:
@@ -360,7 +380,8 @@ jobs:
         working-directory: 'grails-forge'
         run: >
           ./gradlew publish aggregateChecksums aggregatePublishedArtifacts
-          -Dorg.gradle.internal.publish.checksums.insecure=true --no-build-cache --rerun-tasks
+          --no-build-cache
+          --rerun-tasks
       - name: "📤 Upload grails-forge checksums"
         uses: actions/upload-artifact@v4
         with:

.github/workflows/groovy-joint-workflow.yml

@@ -161,3 +161,4 @@ jobs:
         run: >
           ./gradlew build
           -x groovydoc
+          -PskipCodeStyle

CONTRIBUTING.md

@@ -239,7 +239,8 @@ changes.
 
 ## Code Style
 
-Grails code style mostly mirrors the Spring Framework's [Style Guide](https://github.com/spring-projects/spring-framework/blob/main/CONTRIBUTING.md#source-code-style).  We are currently working on a more detailed proposal under ticket [#13754](https://github.com/apache/grails-core/issues/13754).
+Grails has a limited set of code styles enforced by Checkstyle (for Java) and CodeNarc (for Groovy).
+To check compliance with the code styles, run the `codeStyle` Gradle task.
 
 ### Commit Messages
 

DEVELOPMENT.md

@@ -14,17 +14,34 @@ See the License for the specific language governing permissions and
 limitations under the License.
 -->
 
-# Various properties that control which & how tests run
-* onlyFunctionalTests - runs only grails-test-examples/* tests
-* onlyHibernate5Tests - runs only a hibernate5 related test
-* onlyMongodbTests - runs only a mongodb related test
-* onlyCoreTests - runs tests that do not include mongo, hibernate, or functional
-* skipFunctionalTests - does not run the functional tests
-* skipHibernate5Tests - does not run hibernate5 related tests
-* skipMongodbTests - does not run mongo related tests
-* skipCoreTests - does not run the "core" tests
-* serializeMongoTests - if true, only integration tests from one mongo project will run at a time
-* skipTests - no tests will run
-
-# Start a mongo docker container (containers will start by default)
+# Development
+
+## Useful Custom Gradle tasks
+
+These tasks can be run like so:
+
+`./gradlew publishGuide`
+
+* `codeStyle` - runs all code style checks
+* `publishGuide` - generates the user guide in the `grails-doc/build/original-guide`
+
+## Various properties that control which tasks to run
+
+These can be set on the command line like so:
+
+`./gradlew check -PskipCodeStyle`
+
+* `onlyCoreTests` - runs tests that do not include mongo, hibernate, or functional
+* `onlyFunctionalTests` - runs only grails-test-examples/* tests
+* `onlyHibernate5Tests` - runs only a hibernate5 related test
+* `onlyMongodbTests` - runs only a mongodb related test
+* `serializeMongoTests` - if true, only integration tests from one mongo project will run at a time
+* `skipCodeStyle` - does not run code style checks
+* `skipCoreTests` - does not run the "core" tests
+* `skipFunctionalTests` - does not run the functional tests
+* `skipHibernate5Tests` - does not run hibernate5 related tests
+* `skipMongodbTests` - does not run mongo related tests
+* `skipTests` - no tests will run
+
+## Start a mongo docker container (containers will start by default)
 `docker run -d  --name mongo-on-docker  -p 27017:27017 mongo`

etc/config/checkstyle/checkstyle-suppressions.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+-->
+<!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN" "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+<suppressions>
+</suppressions>