Azkaban builds use Gradle and requires Java 8 or higher.
The following set of commands run on *nix platforms like Linux, OS X.
# Build Azkaban ./gradlew build # Clean the build ./gradlew clean # Build and install distributions ./gradlew installDist # Run tests ./gradlew test # Build without running tests ./gradlew build -x test
Build a release
Pick a release from the release page. Find the tag corresponding to the release.
Check out the source code corresponding to that tag. e.g.
git checkout 3.30.1
./gradlew clean build
The current documentation will be deprecated soon at azkaban.github.io.
The new Documentation site is under development.
The source code for the documentation is inside
For help, please visit the Azkaban Google Group.
If you want to contribute to the documentation or the release tool (inside the
please make sure python3 is installed in your environment. python virtual environment is recommended to run these scripts.
To create a venv & install the python3 dependencies inside it, run
python3 -m venv venv source venv/bin/activate pip3 install -r requirements.txt
After, enter the documentation folder
docs and make the build by running
cd docs make html
Find the built docs under
For example on a Mac, open them in browser with:
open -a "Google Chrome" _build/html/index.html
[July, 2018] We are actively improving our documentation. Everyone in the AZ community is welcome to submit a pull request to edit/fix the documentation.