mirror of
https://github.com/datahub-project/datahub.git
synced 2025-07-06 08:38:41 +00:00
46 lines
1.7 KiB
Markdown
46 lines
1.7 KiB
Markdown
# 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](https://docs.gradle.org/current/userguide/gradle_wrapper.html) to build the project
|
|
```
|
|
./gradlew build
|
|
```
|
|
|
|
## IDE Support
|
|
The recommended IDE for DataHub development is [IntelliJ IDEA](https://www.jetbrains.com/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](https://www.oracle.com/java/technologies/javase-jdk8-downloads.html) (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](https://docs.oracle.com/cd/E21454_01/html/821-2531/inst_jdk_javahome_t.html) 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.
|