Google Git
Sign in
apache / kafka / 4d0759713fb2722bac8ce7dcbbb047d7af99280a
commit4d0759713fb2722bac8ce7dcbbb047d7af99280a[log] [tgz]
authorIvan Lyutov <ivanlyutov@gmail.com>Sun Aug 10 21:20:30 2014 -0700
committerJun Rao <junrao@gmail.com>Sun Aug 10 21:20:30 2014 -0700
treed0a4128eafe23bf1f17f359fcbb26d25ff44788a
parentc9894fb6ee4d33155bdb669a2e2f64ed9c3f9441 [diff]
kafka-1419; cross build for scala 2.11; patched by Ivan Lyutov; reviewed by Joe Stein and Jun Rao
13 files changed
tree: d0a4128eafe23bf1f17f359fcbb26d25ff44788a
  1. bin/
  2. clients/
  3. config/
  4. contrib/
  5. core/
  6. examples/
  7. gradle/
  8. lib/
  9. system_test/
  10. .gitignore
  11. .rat-excludes
  12. .reviewboardrc
  13. build.gradle
  14. doap_Kafka.rdf
  15. gradle.properties
  16. gradlew
  17. gradlew.bat
  18. HEADER
  19. kafka-patch-review.py
  20. LICENSE
  21. NOTICE
  22. README.md
  23. scala.gradle
  24. settings.gradle
README.md

Apache Kafka

See our web site for details on the project.

Building a jar and running it

./gradlew jar

Follow instuctions in http://kafka.apache.org/documentation.html#quickstart

Building source jar

./gradlew srcJar

Building javadocs and scaladocs

./gradlew javadoc
./gradlew javadocJar # builds a jar from the javadocs
./gradlew scaladoc
./gradlew scaladocJar # builds a jar from the scaladocs
./gradlew docsJar # builds both javadoc and scaladoc jar

Running unit tests

./gradlew test

Forcing re-running unit tests w/o code change

./gradlew cleanTest test

Running a particular unit test

./gradlew -Dtest.single=RequestResponseSerializationTest core:test

Running a particular unit test with log4j output

change the log4j setting in either clients/src/test/resources/log4j.properties or core/src/test/resources/log4j.properties
./gradlew -i -Dtest.single=RequestResponseSerializationTest core:test

Building a binary release gzipped tar ball

./gradlew clean
./gradlew releaseTarGz  
The above command will fail if you haven't set up the signing key. To bypass signing the artifact, you can run
./gradlew releaseTarGz -x signArchives

The release file can be found inside ./core/build/distributions/.

Cleaning the build

./gradlew clean

Running a task on a particular version of Scala (either 2.9.1, 2.9.2, 2.10.1 or 2.11)

(If building a jar with a version other than 2.10, the scala version variable in bin/kafka-run-class.sh needs to be changed to run quick start.)

./gradlew -PscalaVersion=2.9.1 jar
./gradlew -PscalaVersion=2.9.1 test
./gradlew -PscalaVersion=2.9.1 releaseTarGz

Running a task for a specific project

This is for ‘core’, ‘perf’, ‘contrib:hadoop-consumer’, ‘contrib:hadoop-producer’, ‘examples’ and ‘clients’ ./gradlew core:jar ./gradlew core:test

Listing all gradle tasks

./gradlew tasks

Building IDE project

./gradlew eclipse
./gradlew idea

Building the jar for all scala versions and for all projects

./gradlew jarAll

Running unit tests for all scala versions and for all projects

./gradlew testAll

Building a binary release gzipped tar ball for all scala versions

./gradlew releaseTarGzAll

Publishing the jar for all version of Scala and for all projects to maven

./gradlew uploadArchivesAll

Please note for this to work you should create/update ~/.gradle/gradle.properties and assign the following variables

mavenUrl=
mavenUsername=
mavenPassword=
signing.keyId=
signing.password=
signing.secretKeyRingFile=

Building the test jar

./gradlew testJar

Determining how transitive dependencies are added

./gradlew core:dependencies --configuration runtime

Contribution

Apache Kafka interested in building the community; we would welcome any thoughts or patches. You can reach us on the Apache mailing lists.

To contribute follow the instructions here:

We also welcome patches for the website and documentation which can be found here: