46 lines
1.3 KiB
Markdown
Raw Normal View History

2021-08-01 14:27:44 -07:00
# Build the code & run tests
## Prerequisites
2021-08-12 17:45:27 +00:00
First of all you need to make sure you are using maven 3.5.x or higher and JDK 11 or higher.
2021-08-01 14:27:44 -07:00
## Building
The following commands must be run from the top-level directory.
`mvn clean install`
If you wish to skip the unit tests you can do this by adding `-DskipTests` to the command line.
## Create a distribution \(packaging\)
You can create a _distribution_ as follows.
```text
$ mvn clean install
# Create the binary distribution.
$ cd dist && mvn package
```
The binaries will be created at:
```text
dist/target/open-metadata-<version>.pom
dist/target/open-metadata-<version>.tar.gz
```
2021-08-12 17:45:27 +00:00
## Run instance through IntelliJ IDEA
2021-08-01 14:27:44 -07:00
1. Add new Run/Debug configuration like below screenshot.
![Intellj Run Configuration](https://github.com/open-metadata/OpenMetadata/blob/main/docs/install/images/ingestion-bot-service-account.png)
2021-08-01 14:27:44 -07:00
## Coding Style
1. [Refer to coding guidelines](https://github.com/open-metadata/OpenMetadata/blob/main/docs/open-source-community/developer/coding-style.md)
2021-08-12 17:45:27 +00:00
2. Configure IntelliJ to disable the \[wild-card imports\]
2021-08-01 14:27:44 -07:00
\([https://www.jetbrains.com/help/idea/creating-and-optimizing-imports.html\#disable-wildcard-imports](https://www.jetbrains.com/help/idea/creating-and-optimizing-imports.html#disable-wildcard-imports)\)