Developer Guide

Setup development environment on Linux

• Install intellij community edition from [here] (https://www.jetbrains.com/idea/download/#section=linux)
• Install gradle from [here] (https://gradle.org/post-download-gradle/)
• Install jdk from [here] (http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)

Setup development environment on Mac

• Install intellij community edition from [here] (https://www.jetbrains.com/idea/download/#)
• Install java 8 by running brew cask install java
• Install gradle by running brew install gradle

Setup development environment on Windows

• Install intellij community edition from [here] (https://www.jetbrains.com/idea/download/#section=windows)
• Install Java by running choco install jdk8. If you don't have chocolatey. You can install it from [here] (https://chocolatey.org/install)
• Install gradle by running choco install gradle

Building

If you are using windows, please replace gradlew with gradlew.bat

Building, testing and publishing brooklin

Clone the brooklin repository into /path/to/brooklin/localrepo and run the following commands

cd /path/to/brooklin/localrepo
gradle wrapper
gradlew clean assemble

To run unit tests:

cd /path/to/brooklin/localrepo
gradlew test

You can release the brooklin binaries into local maven repository by running

gradlew publishToMavenLocal

You can build the brooklin tar ball by running

gradlew releaseTarGz

Developing using Idea

You can use intellij for developing brooklin. You can build the intellij project files by running

gradlew idea

Once the intellij project files (*.ipr) are created, You can open them using Intellij and Start developing.

Contributing and submitting patches

Contributions are accepted in the form of pull requests, please use this https://help.github.com/articles/using-pull-requests/ on how to submit the pull request.

Before you submit the pull request, ensure that your changes in your fork builds and tests run with the latest changes from upstream. To sync the changes from the main repository into your fork you can follow the instructions here https://help.github.com/articles/syncing-a-fork/