mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-05 16:19:35 +00:00
47 lines
1.4 KiB
Markdown
47 lines
1.4 KiB
Markdown
|
# Build the code & run tests
|
||
|
|
|
||
|
|
## Prerequisites
|
||
|
|
|
||
|
|
Firt of all you need to make sure you are using maven 3.5.x or higher and JDK 11 or higher.
|
||
|
|
|
||
|
|
## 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
|
||
|
|
dist/target/open-metadata-<version>.zip
|
||
|
|
```
|
||
|
|
|
||
|
|
## Run instance through Intellij
|
||
|
|
|
||
|
|
1. Add new Run/Debug configuration like below screenshot.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Coding Style
|
||
|
|
|
||
|
|
1. [Refer to coding guidelines](https://github.com/StreamlineData/catalog/tree/b882d5238a1e21ebc73edb1693a59296f4d38e24/docs/open-source-community/open-source-community/coding-style.md)
|
||
|
|
2. Configure Intellij to disable the \[wild-card imports\]
|
||
|
|
|
||
|
|
\([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)\)
|
||
|
|
|