root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

MINOR; Update documentation for printing dependencies (#12610) 

Reviewers: Ismael Juma <ismael@juma.me.uk>
This commit is contained in:
José Armando García Sancio 2022-10-17 11:27:49 -07:00 committed by GitHub
parent de8c9ea04c
commit e8e815b1b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -201,12 +201,6 @@ If needed, you can specify the Scala version with `-PscalaVersion=2.13`.
### Building the test jar ###
./gradlew testJar
### Determining how transitive dependencies are added ###
./gradlew core:dependencies --configuration runtime
### Determining if any dependencies could be updated ###
./gradlew dependencyUpdates
### Running code quality checks ###
There are two code quality analysis tools that we regularly run, spotbugs and checkstyle.
@ -233,6 +227,21 @@ We use [JMH](https://openjdk.java.net/projects/code-tools/jmh/) to write microbe
See [jmh-benchmarks/README.md](https://github.com/apache/kafka/blob/trunk/jmh-benchmarks/README.md) for details on how to run the microbenchmarks.
### 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.
Alternatively, use the `allDeps` or `allDepInsight` tasks for recursively iterating through all subprojects:
./gradlew allDeps
./gradlew allDepInsight --configuration runtimeClasspath --dependency com.fasterxml.jackson.core:jackson-databind
These take the same arguments as the builtin variants.
### Determining if any dependencies could be updated ###
./gradlew dependencyUpdates
### Common build options ###
The following options should be set with a `-P` switch, for example `./gradlew -PmaxParallelForks=1 test`.
@ -260,18 +269,6 @@ only safe if the Scala library version is the same at compile time and runtime.
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.
### 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.
Alternatively, use the `allDeps` or `allDepInsight` tasks for recursively iterating through all subprojects:
./gradlew allDeps
./gradlew allDepInsight --configuration runtimeClasspath --dependency com.fasterxml.jackson.core:jackson-databind
These take the same arguments as the builtin variants.
### Running system tests ###
See [tests/README.md](tests/README.md).