36 lines
1.8 KiB
Markdown
36 lines
1.8 KiB
Markdown
# How to build project
|
|
This document helps people to compile and build the project in your maven and set your IDE.
|
|
|
|
## Build Project
|
|
**Because we are using Git submodule, we recommend don't use `GitHub` tag or release page to download source codes for compiling.**
|
|
|
|
### Build from GitHub
|
|
1. Prepare git, JDK8 and maven3
|
|
1. `git clone https://github.com/apache/incubator-skywalking.git`
|
|
1. `cd incubator-skywalking/`
|
|
1. Switch to the tag by using `git checkout [tagname]` (Optional, switch if want to build a release from source codes)
|
|
1. `git submodule init`
|
|
1. `git submodule update`
|
|
1. Run `mvn clean package -DskipTests`
|
|
1. All packages are in `/dist`.(.tar.gz for Linux and .zip for Windows).
|
|
|
|
### Build from Apache source codes
|
|
1. Prepare JDK8 and maven3
|
|
1. Run `mvn clean package -DskipTests`
|
|
1. All packages are in `/dist`.(.tar.gz for Linux and .zip for Windows).
|
|
|
|
## Setup your IntelliJ IDEA
|
|
1. Import the project as a maven project
|
|
1. Run `mvn compile -Dmaven.test.skip=true` to compile project and generate source codes. Because we use gRPC and protobuf.
|
|
1. Set **Generated Source Codes** folders.
|
|
* `grpc-java` and `java` folders in **apm-protocol/apm-network/target/generated-sources/protobuf**
|
|
* `grpc-java` and `java` folders in **apm-collector/apm-collector-remote/apm-remote-grpc-provider/target/protobuf**
|
|
|
|
## Building Resin-3, Resin-4, and OJDBC sdk plugins
|
|
Due to license incompatibilities/restrictions these plugins under `apm-sniffer/apm-sdk-plugin/` are not built by default.
|
|
Download them manually into the `ci-dependencies/` directory and the plugins will be included in the maven reactor and built.
|
|
The names of the artifacts downloaded and placed in the `ci-dependencies/` directory must be exact:
|
|
* resin-3.0.9.jar
|
|
* resin-4.0.41.jar
|
|
* ojdbc14-10.2.0.4.0.jar
|