Setup build to run Apache RAT

Author: jdaugherty

.github/workflows/rat.yml

@@ -0,0 +1,43 @@
+name: RAT Report
+on:
+  push:
+    branches:
+      - '[4-9]+.[0-9]+.x'
+      - '[3-9]+.[3-9]+.x'
+      - license-audit
+  pull_request:
+    branches:
+      - '[4-9]+.[0-9]+.x'
+      - '[3-9]+.[3-9]+.x'
+      - license-audit
+  workflow_dispatch:
+jobs:
+  rat-audit:
+    permissions:
+      contents: read  #  to fetch code (actions/checkout)
+    runs-on: ubuntu-latest
+    steps:
+      - 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: "🧐 Apache License - Release Audit Tool"
+        run: ./gradlew rat
+      - name: Upload RAT HTML report
+        if: always()
+        uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0
+        with:
+          name: rat-report
+          path: build/reports/rat/index.html
+      - name: Publish RAT report in Job Summary
+        run: |
+          echo "## 📋 Apache RAT Report" >> $GITHUB_STEP_SUMMARY
+          # inject raw HTML (it will render as HTML in the summary)
+          cat build/reports/rat/index.html >> $GITHUB_STEP_SUMMARY

LICENSE

@@ -1,6 +1,7 @@
-Apache License
+
+                                 Apache License
                            Version 2.0, January 2004
-                        https://www.apache.org/licenses/
+                        http://www.apache.org/licenses/
 
    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 

NOTICE

@@ -0,0 +1,5 @@
+Apache Groovy
+Copyright 2003-2025 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).

build.gradle

@@ -79,6 +79,7 @@ tasks.register('clean', Delete).configure {
 apply {
     from layout.projectDirectory.file('gradle/assemble-root-config.gradle')
     from layout.projectDirectory.file('gradle/publish-root-config.gradle')
+    from layout.projectDirectory.file('gradle/rat-root-config.gradle')
 }
 
 // For debugging the gradle task graph: Uncomment to show task dependencies when a task is run

buildSrc/build.gradle

@@ -30,4 +30,5 @@ dependencies {
     implementation 'org.apache.grails:grails-gradle-plugins'
     implementation 'org.asciidoctor:asciidoctor-gradle-jvm'
     implementation 'org.springframework.boot:spring-boot-gradle-plugin'
+    implementation 'org.nosphere.apache.rat:org.nosphere.apache.rat.gradle.plugin:0.8.1'
 }

gradle/rat-root-config.gradle

@@ -0,0 +1,12 @@
+apply plugin: 'org.nosphere.apache.rat'
+
+tasks.named('rat') {
+    excludes = [
+            '.asf.yaml', // ASF metadata for github integration excluded from src zip
+            '**/build/**', // Gradle generated build directories
+            '**/.gradle/**', '**/wrapper/**', 'gradlew*',  // gradle wrapper files excluded from src zip
+            '**/*.html', // html files are only in test
+            '**/resources/*', // exclude test artifacts
+            'out/**', '*.ipr', '**/*.iml', '*.iws', '.idea/**', // Intellij generated files
+    ]
+}