Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 1.95 KB

developers.md

File metadata and controls

49 lines (35 loc) · 1.95 KB
Raw

DataHub Developer's Guide

Building the Project

Fork and clone the repository if haven't done so already

git clone https://github.com/{username}/datahub.git

Change into the repository's root directory

cd datahub

Use gradle wrapper to build the project

./gradlew build

IDE Support

The recommended IDE for DataHub development is IntelliJ IDEA. You can run the following command to generate or update the IntelliJ project file

./gradlew idea

Open datahub.ipr in IntelliJ to start developing!

Common Build Issues

Getting Unsupported class file major version 57

You're probably using a Java version that's too new for gradle. Run the following command to check your Java version

java --version

While it may be possible to build and run DataHub using newer versions of Java, we currently only support Java 1.8 (aka Java 8).

Getting cannot find symbol error for javax.annotation.Generated

Similar to the previous issue, please use Java 1.8 to build the project. You can install multiple version of Java on a single machine and switch between them using the JAVA_HOME environment variable. See this document for more details.

:metadata-models:generateDataTemplate task fails with java.nio.file.InvalidPathException: Illegal char <:> at index XX error

This is a known issue when building the project on Windows due a bug in the Pegasus plugin. Please build on a Mac or Linux instead.

Various errors related to generateDataTemplate or other generate tasks

As we generate quite a few files from the models, it is possible that old generated files may conflict with new model changes. When this happens, a simple ./gradlew clean should reosolve the issue.