Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 1.32 KB

BUILD.md

File metadata and controls

25 lines (17 loc) · 1.32 KB
Raw

How to Build

To build Data Cooker ETL executable FatJAR artifact, you need Java 11 and Apache Maven.

Minimum supported version of Maven is enforced in the project file, so please look into enforcer plugin section. For Java, Amazon's Corretto is the preferred distribution.

There are two profiles to target AWS EMR production environment (EMR — selected by default) and for local debugging of ETL processes (local), so you have to call

mvn clean package

or

mvn -Plocal clean package

to build a desired flavor of datacooker-etl-cli.jar.

Currently supported version of EMR is 6.9. For local debugging, Ubuntu 22.04 is recommended (either native or inside WSL).

Documentation Generator

This companion utility is automatically called in the build process to extract the modules' metadata, and provides the evergreen, always updated documentation.

Its main class is io.github.pastorgl.datacooker.doc.DocGen, execution scope is test, and two required command line parameters specify documentation location directory and distro name.

By default, directory is docs, where both HTML (single-file and linked files) and PDF formats docs are placed.