[apache#5937]feat(build): enhance spotless integration in Gradle buil…

…d script (apache#6077)

### What changes were proposed in this pull request?
Added configuration to ensure that subprojects using the
'com.diffplug.spotless' plugin are included in the 'spotlessCheck' task
dependencies.

### Why are the changes needed?
Fix: apache#5937

### Does this PR introduce any user-facing change?
no

### How was this patch tested?
Break style by adding spaces to any java file in iceberg-common module,
and test it by running ./gradlew compileIcebergRESTServer -x test
check dependence trees by running ./gradlew compileIcebergRESTServer
taskTree

build.gradle.kts

@@ -501,6 +501,9 @@ subprojects {
       exclude("test/**")
     }
   }
+  tasks.named("compileJava").configure {
+    dependsOn("spotlessCheck")
+  }
 }
 
 tasks.rat {