Merge pull request #6 from grails-plugins/feedback

Initial Project Feedback

Author: matrei

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -41,7 +41,7 @@ body:
     id: actual
     attributes:
       label: Actual Behavior
-      description: What actually happened? Include the Server-Timing header value if relevant.
+      description: What actually happened? Include the `Server-Timing` header value if relevant.
     validations:
       required: true
 

.github/SECURITY.md

@@ -22,15 +22,15 @@ using [GitHub's private vulnerability reporting](https://github.com/grails-plugi
 
 ## Security Considerations
 
-This plugin injects `Server-Timing` headers that expose server-side timing information. By default, the plugin is *
+This plugin injects `Server-Timing` header that expose server-side timing information. By default, the plugin is *
 *disabled in production** to mitigate the risk
 of [timing attacks](https://w3c.github.io/server-timing/#security-considerations).
 
 If you enable the plugin in production, be aware that:
 
 - Timing data may help attackers infer information about server-side operations (e.g., whether a database lookup found a
   record)
-- Cross-origin access to `Server-Timing` data requires the `Timing-Allow-Origin` header, which this plugin does **not**
+- Cross-origin access to Server Timing data requires the `Timing-Allow-Origin` header, which this plugin does **not**
   set automatically
 
 See the [W3C Server Timing Security Considerations](https://w3c.github.io/server-timing/#security-considerations) for

.github/dependabot.yml

@@ -1,6 +1,6 @@
 version: 2
 updates:
-  # Gradle dependencies (root + all subprojects)
+  # Gradle dependencies and wrapper
   - package-ecosystem: "gradle"
     directory: "/"
     schedule:
@@ -13,15 +13,8 @@ updates:
       gradle-dependencies:
         patterns:
           - "*"
-
-  # Gradle wrapper
-  - package-ecosystem: "gradle"
-    directory: "/gradle/wrapper"
-    schedule:
-      interval: "weekly"
-      day: "monday"
-    labels:
-      - "deps"
+        exclude-patterns:
+          - "gradle"
     ignore:
       - dependency-name: "gradle"
         versions: [ ">= 9" ]

.github/workflows/ci.yml

@@ -6,6 +6,8 @@ on:
       - 'main'
   pull_request:
   workflow_dispatch:
+env:
+  JAVA_DISTRIBUTION: 'liberica'
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: ${{ github.event_name == 'pull_request' }}
@@ -28,12 +30,18 @@ jobs:
       - name: "☕️ Setup JDK"
         uses: actions/setup-java@v5
         with:
-          distribution: liberica
+          distribution: ${{ env.JAVA_DISTRIBUTION }}
           java-version: ${{ env.SDKMANRC_java }}
       - name: 'Ensure Common Build Date' # to ensure a reproducible build
         run: echo "SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)" >> "$GITHUB_ENV"
+      - name: "Export gradle.properties properties"
+        uses: apache/grails-github-actions/export-gradle-properties@asf
       - name: "🐘 Setup Gradle"
         uses: gradle/actions/setup-gradle@v5
+        with:
+          build-scan-publish: ${{ env.ciBuildScanPublish }}
+          build-scan-terms-of-use-url: ${{ env.ciBuildScanTermsOfUseUrl }}
+          build-scan-terms-of-use-agree: ${{ env.ciBuildScanTermsOfUseAgree }}
       - name: "🔨 Build project without tests"
         if: ${{ contains(github.event.head_commit.message, '[skip tests]') }}
         run: >
@@ -51,9 +59,10 @@ jobs:
           --rerun-tasks
           -PskipCodeStyle
   publish:
-    # only run the publish task on this repo instead of forks
+    # only run the publishing task on this repo (not on forks)
     if: github.repository_owner == 'grails-plugins' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch')
-    needs: [ build ]
+    needs: build
+    name: "Publish Snapshot"
     runs-on: ubuntu-24.04
     steps:
       - name: "Output Agent IP" # in the event your agent has network issues, you can use this to debug
@@ -70,28 +79,31 @@ jobs:
       - name: "☕️ Setup JDK"
         uses: actions/setup-java@v5
         with:
-          distribution: liberica
+          distribution: ${{ env.JAVA_DISTRIBUTION }}
           java-version: ${{ env.SDKMANRC_java }}
       - name: 'Ensure Common Build Date' # to ensure a reproducible build
         run: echo "SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)" >> "$GITHUB_ENV"
+      - name: "Export gradle.properties properties"
+        uses: apache/grails-github-actions/export-gradle-properties@asf
       - name: "🐘 Setup Gradle"
         uses: gradle/actions/setup-gradle@v5
+        with:
+          build-scan-publish: ${{ env.ciBuildScanPublish }}
+          build-scan-terms-of-use-url: ${{ env.ciBuildScanTermsOfUseUrl }}
+          build-scan-terms-of-use-agree: ${{ env.ciBuildScanTermsOfUseAgree }}
       - name: "📤 Publish Gradle Snapshot Artifacts"
         env:
           GRAILS_PUBLISH_RELEASE: 'false'
           MAVEN_PUBLISH_URL: 'https://central.sonatype.com/repository/maven-snapshots/'
           MAVEN_PUBLISH_USERNAME: ${{ secrets.NEXUS_PUBLISH_USERNAME }}
           MAVEN_PUBLISH_PASSWORD: ${{ secrets.NEXUS_PUBLISH_PASSWORD }}
-        working-directory: './plugin'
         run: >
           ../gradlew publish
           --no-build-cache
           --rerun-tasks
       - name: "📜 Generate Documentation"
-        if: success()
         run: ./gradlew docs
       - name: "🚀 Publish to Github Pages"
-        if: success()
         uses: apache/grails-github-actions/deploy-github-pages@asf
         env:
           GRADLE_PUBLISH_RELEASE: 'false'

.github/workflows/coverage.yml .github/workflows/code-coverage.yml.github/workflows/coverage.yml renamed to .github/workflows/code-coverage.yml

@@ -1,4 +1,4 @@
-name: "Coverage"
+name: "Code Coverage"
 on:
   push:
     branches:
@@ -28,20 +28,26 @@ jobs:
         with:
           distribution: liberica
           java-version: ${{ env.SDKMANRC_java }}
+      - name: "Export gradle.properties properties"
+        uses: apache/grails-github-actions/export-gradle-properties@asf
       - name: "🐘 Setup Gradle"
         uses: gradle/actions/setup-gradle@v5
+        with:
+          build-scan-publish: ${{ env.ciBuildScanPublish }}
+          build-scan-terms-of-use-url: ${{ env.ciBuildScanTermsOfUseUrl }}
+          build-scan-terms-of-use-agree: ${{ env.ciBuildScanTermsOfUseAgree }}
       - name: "🔨 Build and run tests"
         run: >
           ./gradlew build
           --continue
           --stacktrace
           -PskipCodeStyle
-      - name: "📊 Post coverage summary"
+      - name: "📊 Post code coverage summary"
         if: always()
         run: |
-          REPORT="coverage/build/reports/jacoco/jacocoAggregatedReport/jacocoAggregatedReport.xml"
+          REPORT="code-coverage/build/reports/jacoco/jacocoAggregatedReport/jacocoAggregatedReport.xml"
           if [ ! -f "$REPORT" ]; then
-            echo "::warning::Coverage report not found at $REPORT"
+            echo "::warning::Code Coverage report not found at $REPORT"
             exit 0
           fi
 

.github/workflows/code-style.yml

@@ -28,8 +28,14 @@ jobs:
         with:
           distribution: liberica
           java-version: ${{ env.SDKMANRC_java }}
+      - name: "Export gradle.properties properties"
+        uses: apache/grails-github-actions/export-gradle-properties@asf
       - name: "🐘 Setup Gradle"
         uses: gradle/actions/setup-gradle@v5
+        with:
+          build-scan-publish: ${{ env.ciBuildScanPublish }}
+          build-scan-terms-of-use-url: ${{ env.ciBuildScanTermsOfUseUrl }}
+          build-scan-terms-of-use-agree: ${{ env.ciBuildScanTermsOfUseAgree }}
       - name: "🎨 Run code style checks"
         run: >
           ./gradlew codeStyle

.github/workflows/release-notes.yml

@@ -18,7 +18,7 @@ jobs:
     permissions:
       contents: write # write permission is required to create a github release
       pull-requests: write # write permission is required for auto-labeler
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - name: "📝 Update Release Draft"
         uses: release-drafter/release-drafter@v6

.github/workflows/release.yml

@@ -4,7 +4,9 @@ on:
     types: [ published ]
 permissions: { }
 env:
-  # to prevent throttling of the github api, include the github token in an environment variable since the build will check for it
+  # To prevent throttling of the GitHub api,
+  # include the GitHub token in an environment variable
+  # since the build will check for it
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   GRAILS_PUBLISH_RELEASE: 'true'
   JAVA_DISTRIBUTION: 'liberica'
@@ -19,7 +21,7 @@ jobs:
     name: "Stage Jar Files"
     permissions:
       packages: read  #  pre-release workflow
-      contents: write  #  to create release
+      contents: write  #  to create a release
       issues: write  #  to modify milestones
     runs-on: ubuntu-24.04
     steps:
@@ -53,8 +55,14 @@ jobs:
         with:
           distribution: ${{ env.JAVA_DISTRIBUTION }}
           java-version: ${{ env.SDKMANRC_java }}
+      - name: "Export gradle.properties properties"
+        uses: apache/grails-github-actions/export-gradle-properties@asf
       - name: "🐘 Setup Gradle"
         uses: gradle/actions/setup-gradle@v5
+        with:
+          build-scan-publish: ${{ env.ciBuildScanPublish }}
+          build-scan-terms-of-use-url: ${{ env.ciBuildScanTermsOfUseUrl }}
+          build-scan-terms-of-use-agree: ${{ env.ciBuildScanTermsOfUseAgree }}
       - name: "⚙️ Run pre-release"
         uses: apache/grails-github-actions/pre-release@asf
         env:
@@ -71,7 +79,6 @@ jobs:
           ./gradlew
           -Psigning.secretKeyRingFile=${{ github.workspace }}/secring.gpg
           publishMavenPublicationToSonatypeRepository
-          publishPluginMavenPublicationToSonatypeRepository 
           closeSonatypeStagingRepository
       - name: "Generate Build Date file"
         run: echo "$SOURCE_DATE_EPOCH" >> build/BUILD_DATE.txt
@@ -85,7 +92,7 @@ jobs:
     name: "Make Release Files Available"
     environment: release # this step will be delayed until approved
     needs: [ publish ]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     permissions:
       contents: read
     steps:
@@ -108,8 +115,14 @@ jobs:
         with:
           distribution: ${{ env.JAVA_DISTRIBUTION }}
           java-version: ${{ env.SDKMANRC_java }}
+      - name: "Export gradle.properties properties"
+        uses: apache/grails-github-actions/export-gradle-properties@asf
       - name: "🐘 Setup Gradle"
         uses: gradle/actions/setup-gradle@v5
+        with:
+          build-scan-publish: ${{ env.ciBuildScanPublish }}
+          build-scan-terms-of-use-url: ${{ env.ciBuildScanTermsOfUseUrl }}
+          build-scan-terms-of-use-agree: ${{ env.ciBuildScanTermsOfUseAgree }}
       - name: "📤 Release staging repository"
         env:
           NEXUS_PUBLISH_USERNAME: ${{ secrets.MAVEN_USERNAME }}
@@ -124,7 +137,7 @@ jobs:
     environment: docs # this step will be delayed until approved
     name: "Publish Documentation"
     needs: [ publish, release ]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     permissions:
       contents: write # required to publish documentation to github pages branches
     steps:
@@ -147,8 +160,14 @@ jobs:
         with:
           distribution: ${{ env.JAVA_DISTRIBUTION }}
           java-version: ${{ env.SDKMANRC_java }}
+      - name: "Export gradle.properties properties"
+        uses: apache/grails-github-actions/export-gradle-properties@asf
       - name: "🐘 Setup Gradle"
         uses: gradle/actions/setup-gradle@v5
+        with:
+          build-scan-publish: ${{ env.ciBuildScanPublish }}
+          build-scan-terms-of-use-url: ${{ env.ciBuildScanTermsOfUseUrl }}
+          build-scan-terms-of-use-agree: ${{ env.ciBuildScanTermsOfUseAgree }}
       - name: "🔨 Build Documentation"
         run: ./gradlew docs
       - name: "🚀 Publish to Github Pages"
@@ -162,32 +181,11 @@ jobs:
     name: "To Next Version"
     environment: close # this step will be delayed until approved
     needs: [ publish, docs, release ]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     permissions:
       contents: write # required for gradle.properties revert
       issues: write # required for milestone closing
       pull-requests: write # to create the PR that will increment the version
     steps:
-      - name: "📝 Establish release version"
-        run: echo "VERSION=${TAG#v}" >> "$GITHUB_ENV"
-      - name: "📥 Checkout repository"
-        uses: actions/checkout@v6
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          ref: ${{ env.TAG }}
-      - name: "Export .sdkmanrc properties"
-        uses: apache/grails-github-actions/export-gradle-properties@asf
-        with:
-          file: ".sdkmanrc"
-          prefix: "SDKMANRC_"
-      - name: "Determine Java Version"
-        run: echo "SDKMANRC_java=${{ env.SDKMANRC_java }}" | sed 's/-.*//' >> $GITHUB_ENV
-      - name: "☕️ Setup JDK"
-        uses: actions/setup-java@v5
-        with:
-          distribution: ${{ env.JAVA_DISTRIBUTION }}
-          java-version: ${{ env.SDKMANRC_java }}
-      - name: "🐘 Setup Gradle"
-        uses: gradle/actions/setup-gradle@v5
       - name: "⚙️ Run post-release"
         uses: apache/grails-github-actions/post-release@asf