-
Notifications
You must be signed in to change notification settings - Fork 137
Developer Guide
To develop Brooklin, you need to have the following depenencies installed:
- Gradle (https://docs.gradle.org/4.10.3/userguide/installation.html)
- JDK 8+ (https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
- Git (https://git-scm.com/downloads)
- Python 2.3+ (https://www.python.org/downloads/)
If you do not have a Java IDE set up, you can download and install the latest version of IntelliJ IDEA Community Edition for your platform at https://www.jetbrains.com/idea/download/.
- To clone the Brooklin repository, run the following command from termina/command line:
git clone https://github.com/linkedin/Brooklin.git
Note: If you are on Windows, please replace gradlew with gradlew.bat
-
To build Brooklin and run all tests:
cd /path/to/brooklin/localrepo ./gradlew clean build
-
To run unit tests:
cd /path/to/brooklin/localrepo ./gradlew test
-
To release the Brooklin binaries into local Maven repository:
./gradlew publishToMavenLocal
-
To build the Brooklin tarball:
./gradlew releaseTarGz
-
To generate IntelliJ project (ipr) files:
./gradlew idea
-
Contributions are accepted in the form of Pull Requests.
-
Before submitting a Pull Request, please, make sure your changes are building and passing all tests with the latest code in the
master
branch of the Brooklin upstream repo. Please, follow the instructions on this page to learn how to sync a fork with an upstream repository. -
Please, take a moment to read our Contributions guidelines before submitting patches or opening issues.
- Home
- Brooklin Architecture
- Production Use Cases
- Developer Guide
- Documentation
- REST Endpoints
- Connectors
- Transport Providers
- Brooklin Configuration
- Test Driving Brooklin