Runs Checkstyle on a Maven project. The check goal
logs violations and fails the build; the checkstyle and checkstyle-aggregate
goals write an HTML report, on their own or as part of the project site.
mvn checkstyle:check
mvn checkstyle:checkstyleThe plugin requires Maven 3.9.0 and Java 8, and runs Checkstyle 9.3 by default. Projects can use a newer Checkstyle by adding it as a plugin dependency.
- Documentation: https://maven.apache.org/plugins/maven-checkstyle-plugin/
- Issues: https://github.com/apache/maven-checkstyle-plugin/issues
- Security reports: see SECURITY.md; never a public issue
- Agents and automated tools: see AGENTS.md
mvn verifyRun the integration tests in src/it with the run-its profile:
mvn -Prun-its verifyBuild the plugin site, including the goal pages, with:
mvn install -DskipTests
mvn site -PreportingOpen a pull request against master. Discuss larger changes on the
developer mailing list first. See the
guide to helping with Maven
for the general process.