diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 255204700..583367a3d 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -37,4 +37,4 @@ ==== 🆕 Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist 👆 ==== --> - [ ] If this pull request closes/resolves/fixes an existing issue, replace the issue number. Closes #. -- [ ] Update the [`CHANGES` log](https://github.com/apache/skywalking/blob/master/CHANGES.md). +- [ ] Update the [`CHANGES` log](https://github.com/apache/skywalking-java/blob/main/CHANGES.md). diff --git a/README.md b/README.md index b9b361bc1..017bafccb 100644 --- a/README.md +++ b/README.md @@ -20,15 +20,6 @@ SkyWalking: an APM(application performance monitor) system, especially designed # Downloads Please head to the [releases page](https://skywalking.apache.org/downloads/) to download a release of Apache SkyWalking. -# Compiling project -> ./mvnw clean package - -The agent binary package is generated in `skywalking-agent` folder. - -Set **Generated Source Codes**(`grpc-java` and `java` folders in **apm-protocol/apm-network/target/generated-sources/protobuf**) -folders if you are using IntelliJ IDE. - - # Code of conduct This project adheres to the Contributor Covenant [code of conduct](https://www.apache.org/foundation/policies/conduct). By participating, you are expected to uphold this code. Please follow the [REPORTING GUIDELINES](https://www.apache.org/foundation/policies/conduct#reporting-guidelines) to report unacceptable behavior. diff --git a/docs/en/contribution/compiling.md b/docs/en/contribution/compiling.md new file mode 100644 index 000000000..48771ecf7 --- /dev/null +++ b/docs/en/contribution/compiling.md @@ -0,0 +1,18 @@ +# Compiling project +This document will help you compile and build a project in your maven and set your IDE. + +Prepare JDK 8+. + +* If you clone codes from https://github.com/apache/skywalking-java +> git clone https://github.com/apache/skywalking-java.git +> cd skywalking-java +> ./mvnw clean package -Pall + +* If you download source codes tar from https://skywalking.apache.org/downloads/ + +> ./mvnw clean package + +The agent binary package is generated in `skywalking-agent` folder. + +Set **Generated Source Codes**(`grpc-java` and `java` folders in **apm-protocol/apm-network/target/generated-sources/protobuf**) +folders if you are using IntelliJ IDE. \ No newline at end of file diff --git a/docs/en/contribution/release-java-agent.md b/docs/en/contribution/release-java-agent.md index 30291b692..2a367635f 100644 --- a/docs/en/contribution/release-java-agent.md +++ b/docs/en/contribution/release-java-agent.md @@ -45,7 +45,7 @@ This step is only for testing purpose. If your env is correctly set, you don't n ## Prepare for the release ``` ./mvnw release:clean -./mvnw release:prepare -DautoVersionSubmodules=true +./mvnw release:prepare -DautoVersionSubmodules=true -Pall ``` - Set version number as x.y.z, and tag as **v**x.y.z (The version tag must start with **v**. You will find out why this is necessary in the next step.) @@ -54,7 +54,7 @@ _You could do a GPG signature before preparing for the release. If you need to i ## Stage the release ``` -./mvnw release:perform -DskipTests +./mvnw release:perform -DskipTests -Pall ``` - The release will be automatically inserted into a temporary staging repository. diff --git a/docs/menu.yml b/docs/menu.yml index fc325889d..8cbeb69bd 100644 --- a/docs/menu.yml +++ b/docs/menu.yml @@ -80,6 +80,8 @@ catalog: path: "https://skyapmtest.github.io/Agent-Benchmarks/" - name: "Contribution" catalog: + - name: "Compiling Guidance" + path: "/en/contribution/compiling/" - name: "Java Agent Release Guidance" path: "/en/contribution/release-java-agent/" - name: "Changelog" diff --git a/pom.xml b/pom.xml index 811246f33..d16eeb685 100755 --- a/pom.xml +++ b/pom.xml @@ -125,6 +125,43 @@ + + + all + + false + + + + + org.codehaus.mojo + exec-maven-plugin + ${exec-maven-plugin.version} + + + git submodule update + initialize + false + + git + + submodule + update + --init + --recursive + + + + exec + + + + + + + + + junit