From ae39e7b5a1ac2e176119d0e60ceb2c6be7087b63 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=90=B4=E6=99=9F=20Wu=20Sheng?= Date: Mon, 19 Mar 2018 12:22:53 +0800 Subject: [PATCH] Merge release documents (#960) * Update docs for alpha release * Delete a comma. * Update How-to-build.md * Add data-set licenses file * Rename LICENSES-data-set to LICENSE-data-set * Update LICENSE * Remove fastclick from LICENSE * Make the git submodule command to be a maven profile plugin. Let this command not execute by default install command. * [maven-release-plugin] prepare release apm-5.0.0-alpha * [maven-release-plugin] prepare for next development iteration * Product name is not correct * Add more documents for release. * Change profile id. * Add CHANGES file in distribution file. * Revert "[maven-release-plugin] prepare for next development iteration" This reverts commit ac81501929f72ab3a276b8d782759eb6f652bfa3. * Revert "[maven-release-plugin] prepare release apm-5.0.0-alpha" This reverts commit 095597c9189589667c2a333d85bd46f6dca90c80. * Add rat plugin to check dependency license and add license head into missing files. * Fix docs. * Exclude web ui config file. * Next release guide. * UI update. * Update docs. * Build source shell. * Update docs and source release. * remove .sha256 requirement. * Update How-to-release.md * Update How-to-release.md * Update build doc. * Update docs. * Update How-to-release.md * Update How-to-release.md --- apm-webapp/pom.xml | 1 - docs/cn/How-to-build-CN.md | 8 ++-- docs/en/How-to-build.md | 8 ++-- docs/en/How-to-release.md | 57 +++++++++++++++--------- tools/releasing/create_source_release.sh | 2 +- 5 files changed, 45 insertions(+), 31 deletions(-) diff --git a/apm-webapp/pom.xml b/apm-webapp/pom.xml index e311000f77..d8636ddb78 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 c39e59d7f6..223e0bc4cd 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 f744af1dc3..917d2f4aac 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 70053f1aaa..2464a75dc8 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 a08f700d1c..1ef962ec12 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 -- GitLab