From c2de7c5e544b94fe669063e336846b7977b0c044 Mon Sep 17 00:00:00 2001 From: Omnia Ibrahim Date: Thu, 27 Jun 2024 12:04:08 +0100 Subject: [PATCH] MINOR: Clarify Spotless instructions in README.md (#16471) Reviewers: Igor Soarez --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 8419e7cf1ad..7bacfee75d8 100644 --- a/README.md +++ b/README.md @@ -232,11 +232,15 @@ You can run checkstyle using: The checkstyle warnings will be found in `reports/checkstyle/reports/main.html` and `reports/checkstyle/reports/test.html` files in the subproject build directories. They are also printed to the console. The build will fail if Checkstyle fails. +**Please note that `./gradlew spotlessCheck` currently has an issue with Java 21 (see https://github.com/diffplug/spotless/pull/1920), so make sure to run this with JDK 11 or 17** + #### Spotless #### The import order is a part of static check. please call `spotlessApply` (require JDK 11+) to optimize the imports of Java codes before filing pull request. ./gradlew spotlessApply +**Please note that `./gradlew spotlessApply` currently has an issue with Java 21 (see https://github.com/diffplug/spotless/pull/1920), so make sure to run this with JDK 11 or 17** + #### Spotbugs #### Spotbugs uses static analysis to look for bugs in the code. You can run spotbugs using: