Skip to content

KAFKA-12770: introduce checkstyleVersion build option (for overriding CheckStyle project-defined dependency version) #10698

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dejan2609 wants to merge 1 commit into from
Closed

KAFKA-12770: introduce checkstyleVersion build option (for overriding CheckStyle project-defined dependency version) #10698

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@ 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.
For experiments (or regression testing purposes) add -PcheckstyleVersion=8.xy (to override project-defined checkstyle version).

#### Spotbugs ####
Spotbugs uses static analysis to look for bugs in the code.
Expand Down Expand Up @@ -245,7 +246,7 @@ includes inlining of methods within the scala library (which avoids lambda alloc
only safe if the Scala library version is the same at compile time and runtime. Since we cannot guarantee this for all cases (for example, users
may depend on the kafka jar for integration tests where they may include a scala library with a different version), we don't enable it by
default. See https://www.lightbend.com/blog/scala-inliner-optimizer for more details.

* `checkstyleVersion` overrides project-defined checkstyle dependency version. See "Checkstyle" manual section for example how to use it.
### Dependency Analysis ###

The gradle [dependency debugging documentation](https://docs.gradle.org/current/userguide/viewing_debugging_dependencies.html) mentions using the `dependencies` or `dependencyInsight` tasks to debug dependencies for the root project or individual subprojects.
Expand Down
5 changes: 4 additions & 1 deletion build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,9 @@ ext {
generatedDocsDir = new File("${project.rootDir}/docs/generated")

commitId = project.hasProperty('commitId') ? commitId : null

// See README.md for this build option details and example of usage
checkstyleVersion = project.hasProperty('checkstyleVersion') ? checkstyleVersion : versions.checkstyle
}

apply from: file('wrapper.gradle')
Expand Down Expand Up @@ -588,7 +591,7 @@ subprojects {
checkstyle {
configFile = new File(rootDir, "checkstyle/checkstyle.xml")
configProperties = checkstyleConfigProperties("import-control.xml")
toolVersion = versions.checkstyle
toolVersion = checkstyleVersion
}

configure(checkstyleMain) {
Expand Down