diff --git a/apm-webapp/pom.xml b/apm-webapp/pom.xml index e311000f77d61394f09d8fab48359b5255ced878..d8636ddb78040e146ea71970e6a48caae89e640e 100644 --- a/apm-webapp/pom.xml +++ b/apm-webapp/pom.xml @@ -14,7 +14,6 @@ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. ~ See the License for the specific language governing permissions and ~ limitations under the License. - ~ --> diff --git a/docs/cn/How-to-build-CN.md b/docs/cn/How-to-build-CN.md index c39e59d7f6c81de06a9dd332f2d846ea7ef02a83..223e0bc4cd809d0c3bfe09bc593bcba1c3c8ad6b 100644 --- a/docs/cn/How-to-build-CN.md +++ b/docs/cn/How-to-build-CN.md @@ -13,13 +13,13 @@ 1. 切换到tag `git checkout [tagname]` (可选,当需要编译发行版本时,请是切换到指定分支) 1. `git submodule init` 1. `git submodule update` -1. 执行`mvn clean package` -1. 生成包在`/dist`目录下,共发布包(.tar.gz是linux环境,.zip是windows环境) +1. 执行`mvn clean package -DskipTests` +1. 生成包在`/dist`目录下(.tar.gz是linux环境,.zip是windows环境) ### 从Apache源码镜像下载编译 1. 准备环境: jdk8,Maven -1. 执行`mvn clean package` -1. 生成包在`/dist`目录下,共发布包(.tar.gz是linux环境,.zip是windows环境) +1. 执行`mvn clean package -DskipTests` +1. 生成包在`/dist`目录下(.tar.gz是linux环境,.zip是windows环境) ## 在IntelliJ IDEA中编译工程 diff --git a/docs/en/How-to-build.md b/docs/en/How-to-build.md index f744af1dc3d11f5a411bee1a019f54d390e325b5..917d2f4aaca31f65d8c7abd3cc800bafd3448cac 100644 --- a/docs/en/How-to-build.md +++ b/docs/en/How-to-build.md @@ -11,13 +11,13 @@ This document helps people to compile and build the project in your maven and se 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` -1. All packages are in `/dist`, which includes two files(.tar.gz for Linux and .zip for Windows). +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` -1. All packages are in `/dist`, which includes two files(.tar.gz for Linux and .zip for Windows). +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 diff --git a/docs/en/How-to-release.md b/docs/en/How-to-release.md index 70053f1aaa7219301e9345d635c29e4f30147f6e..2464a75dc83392818800c4b13ec515f8119c3ad3 100644 --- a/docs/en/How-to-release.md +++ b/docs/en/How-to-release.md @@ -1,10 +1,10 @@ Apache SkyWalking release guide -------------------- -This documents guide every committer to release SkyWalking in Apache Way, +This document guides every committer to release SkyWalking in Apache Way, and also help committers to check the release for vote. -## SETUP YOUR DEVELOPMENT ENVIRONMENT +## Setup your development environment Use the following block as a template and place it in ~/.m2/settings.xml ``` @@ -28,33 +28,48 @@ Use the following block as a template and place it in ~/.m2/settings.xml ``` -## TEST YOUR SETTINGS +## Test your settings ``` mvn clean install -Papache-release (this will build artifacts, sources and sign) ``` -## PREPARE THE RELEASE +## Prepare the release ``` mvn release:clean -mvn release:prepare +mvn release:prepare -DautoVersionSubmodules=true ``` -## STAGE THE RELEASE FOR A VOTE +## Stage the release for a vote ``` -mvn release:perform +mvn release:perform -DskipTests ``` The release will automatically be inserted into a temporary staging repository for you. -## Build the source code package -TODO +## Build and sign the source code package +```shell +switch to release version tag +cd tools/releasing +sh create_source_release.sh +``` -## Sign the distribution and source code package -TODO +The `apache-skywalking-apm-incubating-x.y.z-src.tgz` should be found in `tools/releasing` folder, +with .asc, .sha512, .md5 -## Upload to Apache svn -TODO +## Find and download distribution in Apache Nexus Staging repositories +1. Use ApacheId to login `https://repository.apache.org/` +1. Go to `https://repository.apache.org/#stagingRepositories` +1. Search `skywalking` and find your staging repository +1. Close the repository and wait for all checks pass. +1. Go to `{REPO_URL}/org/apache/skywalking/apache-skywalking-apm-incubating/x.y.z` +1. Download `.tar.gz` and `.zip` with .asc and .sha1 +## Upload to Apache svn +1. Use ApacheId to login `https://dist.apache.org/repos/dist/dev/incubator/skywalking/` +1. Create folder, named by release version +1. Upload Source code and distribution package (apache-skywalking-incubating-x.y.z-src.tar.gz, apache-skywalking-incubating-x.y.z.tar.gz, apache-skywalking-incubating-x.y.z.zip) +`in svn.apache.org` with .asc, .sha512 + ## Make the internal announcements Send an announcement mail in dev mail list. @@ -101,8 +116,8 @@ within the next couple of days. ``` ## Wait at least 48 hours for test responses -Any PPMC, committer or contributor can test features and visualization this version, and feedback. -PPMC will decide whether start a vote. +Any PPMC, committer or contributor can test features for releasing, and feedback. +Based on that, PPMC will decide whether start a vote. ## Call a vote in dev Call a vote in `dev@skywalking.apache.org` @@ -153,12 +168,12 @@ All PPMC members and committers should check these before vote +1. 1. Features test. 1. All artifacts in staging repository are published with .asc, .md5, *sha1 files -1. Source code and distribution package (apache-skywalking-incubating-x.y.z.src.tar.gz, apache-skywalking-incubating-x.y.z.tar.gz, apache-skywalking-incubating-x.y.z.zip) -`in svn.apache.org` with .asc, .sha512, .sha256 +1. Source code and distribution package (apache-skywalking-incubating-x.y.z-src.tar.gz, apache-skywalking-incubating-x.y.z.tar.gz, apache-skywalking-incubating-x.y.z.zip) +`in svn.apache.org` with .asc, .sha512 1. `LICENSE` and `NOTICE` are in Source code and distribution package. -1. Check `shasum` -1. Build distribution from source code package (apache-skywalking-incubating-x.y.z.src.tar.gz) -1. Apache RAT check. +1. Check `shasum -c apache-skywalking-apm-incubating-x.y.z-src.tgz.sha512` +1. Build distribution from source code package (apache-skywalking-incubating-x.y.z-src.tar.gz) by following this [doc](https://github.com/apache/incubator-skywalking/blob/master/docs/en/How-to-build.md#build-from-apache-source-codes). +1. Apache RAT check. Run `mvn apache-rat:check`. ## Call for a vote in Apache IPMC -Call a vote in `general@incubator.apache.org` \ No newline at end of file +Call a vote in `general@incubator.apache.org` diff --git a/tools/releasing/create_source_release.sh b/tools/releasing/create_source_release.sh index a08f700d1c94f42853150727ac46dfd1a024d51b..1ef962ec12b6384f2e09b8498931ea18218e19bf 100755 --- a/tools/releasing/create_source_release.sh +++ b/tools/releasing/create_source_release.sh @@ -48,4 +48,4 @@ tar czf ${PRODUCT_NAME}-src.tgz ${PRODUCT_NAME} gpg --armor --detach-sig $PRODUCT_NAME-src.tgz md5 -r $PRODUCT_NAME-src.tgz > $PRODUCT_NAME-src.tgz.md5 -shasum -a 512 $PRODUCT_NAME-src.tgz > $PRODUCT_NAME-src.tgz.sha +shasum -a 512 $PRODUCT_NAME-src.tgz > $PRODUCT_NAME-src.tgz.sha512