From dcd6a71fcefa9ee31332ad20435728535827c24a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BD=AD=E5=8B=87=E5=8D=87=20pengys?= <8082209@qq.com> Date: Mon, 19 Mar 2018 06:09:09 +0800 Subject: [PATCH] Asf/5.0 alpha/release (#959) * 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. --- .travis.yml | 2 +- CHANGELOG.md => CHANGES.md | 4 +- LICENSE | 4 +- NOTICE | 10 +- .../META-INF.services/io.opentracing.Tracer | 18 ++ .../META-INF/defines/test_define.define | 18 ++ .../resources/META-INF/defines/storage.define | 18 ++ .../resources/META-INF/defines/storage.define | 18 ++ apm-dist/bin/collectorService.bat | 16 ++ apm-dist/bin/collectorService.sh | 16 ++ apm-dist/bin/startup.bat | 16 ++ apm-dist/bin/startup.sh | 16 ++ apm-dist/bin/webappService.bat | 16 ++ apm-dist/bin/webappService.sh | 16 ++ apm-dist/pom.xml | 34 +++- apm-dist/release-docs/README.txt | 49 +++++ apm-dist/src/main/assembly/binary.xml | 7 + .../apm-sdk-plugin/hystrix-1.x-plugin/pom.xml | 26 ++- .../apm-sdk-plugin/servicecomb-plugin/pom.xml | 22 ++- .../pom.xml | 25 ++- .../pom.xml | 18 ++ apm-webapp/pom.xml | 23 ++- docs/README.md | 1 + docs/cn/How-to-build-CN.md | 18 +- docs/cn/Quick-start-CN.md | 2 +- docs/en/How-to-build.md | 18 +- docs/en/How-to-release.md | 174 ++++++++++++++++-- docs/en/Quick-start.md | 2 +- licenses/LICENSE-data-set | 21 +++ pom.xml | 125 +++++++++++-- skywalking-ui | 2 +- tools/releasing/create_source_release.sh | 51 +++++ 32 files changed, 736 insertions(+), 70 deletions(-) rename CHANGELOG.md => CHANGES.md (97%) create mode 100644 apm-dist/release-docs/README.txt create mode 100644 licenses/LICENSE-data-set create mode 100755 tools/releasing/create_source_release.sh diff --git a/.travis.yml b/.travis.yml index 8b2c7b1d4d..7efdefd837 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,6 +9,6 @@ before_install: install: - jdk_switcher use oraclejdk8 - - mvn clean install --quiet jacoco:report coveralls:report + - mvn clean install -Ptravis-ci-submodule --quiet jacoco:report coveralls:report - mvn clean javadoc:javadoc -Dmaven.test.skip=true --quiet diff --git a/CHANGELOG.md b/CHANGES.md similarity index 97% rename from CHANGELOG.md rename to CHANGES.md index 552f2c0725..362dead318 100644 --- a/CHANGELOG.md +++ b/CHANGES.md @@ -1,6 +1,6 @@ - Release Notes. - Changes by Version + Changes by Version ================== + Release Notes. 5.0.0-alpha ------------------ diff --git a/LICENSE b/LICENSE index 44f795204e..a645858c79 100644 --- a/LICENSE +++ b/LICENSE @@ -248,10 +248,10 @@ The text of each license is also included at licenses/LICENSE-[project].txt. cytoscape-cose-bilkent: https://github.com/cytoscape/cytoscape.js-cose-bilkent , MIT cytoscape-node-html-label: https://github.com/kaluginserg/cytoscape-node-html-label , MIT cytoscape: https://github.com/cytoscape/cytoscape.js , MIT + data-set: https://github.com/antvis/data-set/ , MIT dva-loading: https://github.com/dvajs/dva , MIT dva: https://github.com/dvajs/dva , MIT enquire-js: https://github.com/jljsj/enquire-js , MIT - fastclick: https://github.com/ftlabs/fastclick , MIT lodash-decorators: https://github.com/steelsojka/lodash-decorators , MIT lodash: https://github.com/lodash/lodash , MIT moment: https://github.com/moment/moment , MIT @@ -285,4 +285,4 @@ MPL 2.0 licenses The following components are provided under a MPL 2.0 license. See project link for details. The text of each license is also included at licenses/LICENSE-[project].txt. - H2 Database: http://www.h2database.com/html/main.html , MPL 2.0 or EPL 1.0 \ No newline at end of file + H2 Database: http://www.h2database.com/html/main.html , MPL 2.0 or EPL 1.0 diff --git a/NOTICE b/NOTICE index c5f3387dff..5ef8686a5a 100644 --- a/NOTICE +++ b/NOTICE @@ -1,4 +1,4 @@ -Apache SkyWaling +Apache SkyWalking Copyright 2017-2018 The Apache Software Foundation This product includes software developed at @@ -44,14 +44,6 @@ networking library, which can be obtained at: * LOCATION_IN_GRPC: * netty/third_party/netty -======================================================================== -elasticsearch NOTICE -======================================================================== -Elasticsearch -Copyright 2009-2017 Elasticsearch - -This product includes software developed by The Apache Software -Foundation (http://www.apache.org/). ============================================================== Jetty NOTICE diff --git a/apm-application-toolkit/apm-toolkit-opentracing/src/main/resources/META-INF.services/io.opentracing.Tracer b/apm-application-toolkit/apm-toolkit-opentracing/src/main/resources/META-INF.services/io.opentracing.Tracer index 6184cc8bdb..894da6a64f 100644 --- a/apm-application-toolkit/apm-toolkit-opentracing/src/main/resources/META-INF.services/io.opentracing.Tracer +++ b/apm-application-toolkit/apm-toolkit-opentracing/src/main/resources/META-INF.services/io.opentracing.Tracer @@ -1 +1,19 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# 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. +# +# + org.apache.skywalking.apm.toolkit.opentracing.SkyWalkingTracer diff --git a/apm-collector/apm-collector-core/src/test/resources/META-INF/defines/test_define.define b/apm-collector/apm-collector-core/src/test/resources/META-INF/defines/test_define.define index f43c533bd4..53e3f410d2 100644 --- a/apm-collector/apm-collector-core/src/test/resources/META-INF/defines/test_define.define +++ b/apm-collector/apm-collector-core/src/test/resources/META-INF/defines/test_define.define @@ -1 +1,19 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# 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. +# +# + org.apache.skywalking.apm.collector.core.define.ServiceImpl diff --git a/apm-collector/apm-collector-storage/collector-storage-es-provider/src/main/resources/META-INF/defines/storage.define b/apm-collector/apm-collector-storage/collector-storage-es-provider/src/main/resources/META-INF/defines/storage.define index 2087613b5a..1f9e7a8381 100644 --- a/apm-collector/apm-collector-storage/collector-storage-es-provider/src/main/resources/META-INF/defines/storage.define +++ b/apm-collector/apm-collector-storage/collector-storage-es-provider/src/main/resources/META-INF/defines/storage.define @@ -1,3 +1,21 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# 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. +# +# + org.apache.skywalking.apm.collector.storage.es.define.register.ApplicationEsTableDefine org.apache.skywalking.apm.collector.storage.es.define.register.InstanceEsTableDefine org.apache.skywalking.apm.collector.storage.es.define.register.ServiceNameEsTableDefine diff --git a/apm-collector/apm-collector-storage/collector-storage-h2-provider/src/main/resources/META-INF/defines/storage.define b/apm-collector/apm-collector-storage/collector-storage-h2-provider/src/main/resources/META-INF/defines/storage.define index e6ee39bc46..0f044a0913 100644 --- a/apm-collector/apm-collector-storage/collector-storage-h2-provider/src/main/resources/META-INF/defines/storage.define +++ b/apm-collector/apm-collector-storage/collector-storage-h2-provider/src/main/resources/META-INF/defines/storage.define @@ -1,3 +1,21 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# 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. +# +# + org.apache.skywalking.apm.collector.storage.h2.define.register.NetworkAddressH2TableDefine org.apache.skywalking.apm.collector.storage.h2.define.register.ApplicationH2TableDefine org.apache.skywalking.apm.collector.storage.h2.define.register.InstanceH2TableDefine diff --git a/apm-dist/bin/collectorService.bat b/apm-dist/bin/collectorService.bat index 3bbbd38f53..00bad07f9e 100644 --- a/apm-dist/bin/collectorService.bat +++ b/apm-dist/bin/collectorService.bat @@ -1,3 +1,19 @@ +@REM +@REM Licensed to the Apache Software Foundation (ASF) under one or more +@REM contributor license agreements. See the NOTICE file distributed with +@REM this work for additional information regarding copyright ownership. +@REM The ASF licenses this file to You under the Apache License, Version 2.0 +@REM (the "License"); you may not use this file except in compliance with +@REM the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, software +@REM distributed under the License is distributed on an "AS IS" BASIS, +@REM WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@REM See the License for the specific language governing permissions and +@REM limitations under the License. + @echo off setlocal diff --git a/apm-dist/bin/collectorService.sh b/apm-dist/bin/collectorService.sh index 069a681abc..f20dad32e3 100644 --- a/apm-dist/bin/collectorService.sh +++ b/apm-dist/bin/collectorService.sh @@ -1,3 +1,19 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# 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. + #!/usr/bin/env sh PRG="$0" diff --git a/apm-dist/bin/startup.bat b/apm-dist/bin/startup.bat index 7c00ffbc1c..4feecf3ba2 100644 --- a/apm-dist/bin/startup.bat +++ b/apm-dist/bin/startup.bat @@ -1,3 +1,19 @@ +@REM +@REM Licensed to the Apache Software Foundation (ASF) under one or more +@REM contributor license agreements. See the NOTICE file distributed with +@REM this work for additional information regarding copyright ownership. +@REM The ASF licenses this file to You under the Apache License, Version 2.0 +@REM (the "License"); you may not use this file except in compliance with +@REM the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, software +@REM distributed under the License is distributed on an "AS IS" BASIS, +@REM WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@REM See the License for the specific language governing permissions and +@REM limitations under the License. + @echo off setlocal diff --git a/apm-dist/bin/startup.sh b/apm-dist/bin/startup.sh index 20f3b3b7cd..72cd520aed 100644 --- a/apm-dist/bin/startup.sh +++ b/apm-dist/bin/startup.sh @@ -1,3 +1,19 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# 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. + #!/usr/bin/env sh PRG="$0" diff --git a/apm-dist/bin/webappService.bat b/apm-dist/bin/webappService.bat index daefd067da..22f182d725 100644 --- a/apm-dist/bin/webappService.bat +++ b/apm-dist/bin/webappService.bat @@ -1,3 +1,19 @@ +@REM +@REM Licensed to the Apache Software Foundation (ASF) under one or more +@REM contributor license agreements. See the NOTICE file distributed with +@REM this work for additional information regarding copyright ownership. +@REM The ASF licenses this file to You under the Apache License, Version 2.0 +@REM (the "License"); you may not use this file except in compliance with +@REM the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, software +@REM distributed under the License is distributed on an "AS IS" BASIS, +@REM WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@REM See the License for the specific language governing permissions and +@REM limitations under the License. + @echo off setlocal diff --git a/apm-dist/bin/webappService.sh b/apm-dist/bin/webappService.sh index 9ecb4977d6..c915ff2516 100644 --- a/apm-dist/bin/webappService.sh +++ b/apm-dist/bin/webappService.sh @@ -1,3 +1,19 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# 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. + #!/usr/bin/env sh PRG="$0" diff --git a/apm-dist/pom.xml b/apm-dist/pom.xml index 6b75f1f235..e8be69ef5b 100644 --- a/apm-dist/pom.xml +++ b/apm-dist/pom.xml @@ -1,5 +1,24 @@ - + + + apm org.apache.skywalking @@ -7,7 +26,7 @@ 4.0.0 - apm-dist + apache-skywalking-apm-incubating pom @@ -30,7 +49,7 @@ - skywalking-dist + apache-skywalking-apm-incubating org.apache.maven.plugins @@ -65,8 +84,12 @@ - - + + @@ -74,5 +97,4 @@ - \ No newline at end of file diff --git a/apm-dist/release-docs/README.txt b/apm-dist/release-docs/README.txt new file mode 100644 index 0000000000..d704ef9f8d --- /dev/null +++ b/apm-dist/release-docs/README.txt @@ -0,0 +1,49 @@ +Welcome to Apache SkyWalking +=============================================================================== + +SkyWalking: APM (application performance monitor) tool for distributed systems, +especially designed for microservices, cloud native and container-based (Docker, Kubernetes, Mesos) architectures. +Underlying technology is a distributed tracing system. + +SkyWalking provides a high performance Java agent, lets the users don't need to change any source codes for instrumentation +and distributed tracing. +At the same time, SkyWalking provides backend, including collector and UI, to aggregate, analysis metrics and traces. +In order to visualize the performance data, distributed traces, application topology and alarms. + +SkyWalking "Trace Data Protocol" and "Cross Process Propagation Headers Protocol" open for any other agent implementors, e.g. other language agent or SDK. You can use +You can use our backend to analysis and visualize your data, even can interop your agent/SDK with SkyWalking Java agent. + +SkyWalking backend can be used for other language agent/SDKs, it doesn't design just for Java. + +Getting Started +=============================================================================== +To help you get started, try the following links: + +Getting Started + https://github.com/apache/incubator-skywalking/blob/master/docs/en/Quick-start.md + +Building + https://github.com/apache/incubator-skywalking/blob/master/docs/en/How-to-build.md + +We welcome contributions of all kinds, for details of how you can help + https://github.com/apache/incubator-skywalking/blob/master/CONTRIBUTING.md + +Find the issue tracker from here + https://github.com/apache/incubator-skywalking/issues + +Find our roadmap + https://github.com/apache/incubator-skywalking/blob/master/docs/ROADMAP.md + + +Please help us make Apache SkyWalking better - we appreciate any feedback +you may have. + +Enjoy! + +----------------- + +Licensing +=============================================================================== + +This software is licensed under the terms you may find in the file +named "LICENSE" in this directory. \ No newline at end of file diff --git a/apm-dist/src/main/assembly/binary.xml b/apm-dist/src/main/assembly/binary.xml index 3dd3426acc..9f20b4c2c3 100644 --- a/apm-dist/src/main/assembly/binary.xml +++ b/apm-dist/src/main/assembly/binary.xml @@ -54,15 +54,22 @@ /agent + ${project.basedir}/../ / NOTICE LICENSE + CHANGES + + ${project.basedir}/release-docs + / + + ${project.basedir}/../licenses /licenses diff --git a/apm-sniffer/apm-sdk-plugin/hystrix-1.x-plugin/pom.xml b/apm-sniffer/apm-sdk-plugin/hystrix-1.x-plugin/pom.xml index 9c727065f8..6987ea20e9 100644 --- a/apm-sniffer/apm-sdk-plugin/hystrix-1.x-plugin/pom.xml +++ b/apm-sniffer/apm-sdk-plugin/hystrix-1.x-plugin/pom.xml @@ -1,5 +1,25 @@ - + + + apm-sdk-plugin org.apache.skywalking @@ -9,7 +29,6 @@ apm-hystrix-1.x-plugin - com.netflix.hystrix @@ -18,5 +37,4 @@ provided - - + \ No newline at end of file diff --git a/apm-sniffer/apm-sdk-plugin/servicecomb-plugin/pom.xml b/apm-sniffer/apm-sdk-plugin/servicecomb-plugin/pom.xml index d21081b7d8..5052f440b5 100644 --- a/apm-sniffer/apm-sdk-plugin/servicecomb-plugin/pom.xml +++ b/apm-sniffer/apm-sdk-plugin/servicecomb-plugin/pom.xml @@ -1,5 +1,25 @@ - + + + apm-sdk-plugin org.apache.skywalking diff --git a/apm-sniffer/apm-sdk-plugin/servicecomb-plugin/servicecomb-java-chassis-0.x-plugin/pom.xml b/apm-sniffer/apm-sdk-plugin/servicecomb-plugin/servicecomb-java-chassis-0.x-plugin/pom.xml index d946453bb7..a8a86ed046 100644 --- a/apm-sniffer/apm-sdk-plugin/servicecomb-plugin/servicecomb-java-chassis-0.x-plugin/pom.xml +++ b/apm-sniffer/apm-sdk-plugin/servicecomb-plugin/servicecomb-java-chassis-0.x-plugin/pom.xml @@ -1,5 +1,25 @@ - + + + servicecomb-plugin org.apache.skywalking @@ -12,8 +32,7 @@ servicecomb-java-chassis-0.x-plugin http://maven.apache.org - - + io.servicecomb diff --git a/apm-sniffer/apm-sdk-plugin/servicecomb-plugin/servicecomb-java-chassis-1.x-plugin/pom.xml b/apm-sniffer/apm-sdk-plugin/servicecomb-plugin/servicecomb-java-chassis-1.x-plugin/pom.xml index 28b77e5a9f..fdc5747a7b 100644 --- a/apm-sniffer/apm-sdk-plugin/servicecomb-plugin/servicecomb-java-chassis-1.x-plugin/pom.xml +++ b/apm-sniffer/apm-sdk-plugin/servicecomb-plugin/servicecomb-java-chassis-1.x-plugin/pom.xml @@ -1,4 +1,22 @@ + + diff --git a/apm-webapp/pom.xml b/apm-webapp/pom.xml index 0a68c660b9..d85814467d 100644 --- a/apm-webapp/pom.xml +++ b/apm-webapp/pom.xml @@ -1,5 +1,25 @@ - + + + apm org.apache.skywalking @@ -151,5 +171,4 @@ - \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 3bdfa68267..22e54898b6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,6 +22,7 @@ * Protocol * [Cross Process Propagation Headers Protocol, v1.0](en/Skywalking-Cross-Process-Propagation-Headers-Protocol-v1.md) * [SkyWalking Trace Data Protocol](en/Trace-Data-Protocol.md) + * [Release Guide](en/How-to-release.md) * [Roadmap](ROADMAP.md) * Resources provided by community * [Public speakings](https://github.com/OpenSkywalking/Community#public-speakings) diff --git a/docs/cn/How-to-build-CN.md b/docs/cn/How-to-build-CN.md index 3be74718a0..c39e59d7f6 100644 --- a/docs/cn/How-to-build-CN.md +++ b/docs/cn/How-to-build-CN.md @@ -4,15 +4,25 @@ ### 前言 因为工程结构和代码依赖会随版本变化，如果读者熟悉travis-ci,则可直接参考[.travis.yml](../../.travis.yml) -### 编译步骤 -1. 准备环境，jdk8，Maven +**工程使用Git Submodule，所以不建议使用GitHub的tag和release页面的源码下载，来编译工程** + +### 从GitHub下载代码编译 +1. 准备环境: git, jdk8，Maven 1. `git clone https://github.com/apache/incubator-skywalking.git` +1. `cd incubator-skywalking/` +1. 切换到tag `git checkout [tagname]` (可选，当需要编译发行版本时，请是切换到指定分支) 1. `git submodule init` 1. `git submodule update` 1. 执行`mvn clean package` -1. 生成包在`/dist`目录下，两个skywalking-dist包（.tar.gz是linux环境，.zip是windows环境） +1. 生成包在`/dist`目录下，共发布包（.tar.gz是linux环境，.zip是windows环境） + +### 从Apache源码镜像下载编译 +1. 准备环境: jdk8，Maven +1. 执行`mvn clean package` +1. 生成包在`/dist`目录下，共发布包（.tar.gz是linux环境，.zip是windows环境） + -### 在IntelliJ IDEA中编译工程 +## 在IntelliJ IDEA中编译工程 上述步骤在命令行中，能够很好的编译工程，但导入到编译器中的工程依然会有一些报错，我们需要进行几步简单的操作。 1. 在IntelliJ Terminal中，执行`mvn compile -Dmaven.test.skip=true`进行编译 1. 设置gRPC的自动生成代码目录，为源码目录 diff --git a/docs/cn/Quick-start-CN.md b/docs/cn/Quick-start-CN.md index 211982c252..a718cfbf30 100644 --- a/docs/cn/Quick-start-CN.md +++ b/docs/cn/Quick-start-CN.md @@ -1,5 +1,5 @@ # 部署步骤 -1. 在Maven Central中下载 `org.apache.skywalking.apm-dist`. 或者本地编译程序，在`dist`目录中找到`skywalking-dist.tar.gz/.zip`. +1. 下载`apache-skywalking-apm-incubating-x.y.z.tar.gz` 或 `apache-skywalking-apm-incubating-x.y.z.zip` 1. 部署 Backend 1. [单机模式](Deploy-backend-in-standalone-mode-CN.md) 1. [集群模式](Deploy-backend-in-cluster-mode-CN.md) diff --git a/docs/en/How-to-build.md b/docs/en/How-to-build.md index 290e06153d..f744af1dc3 100644 --- a/docs/en/How-to-build.md +++ b/docs/en/How-to-build.md @@ -1,13 +1,23 @@ # How to build project -This document helps people to compile and build the project in your maven and IDE. +This document helps people to compile and build the project in your maven and set your IDE. -## Build in maven -1. Prepare JDK8 and maven3 +## 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` -1. All packages are in `/dist`, which includes and two collector files(.tar.gz for Linux and .zip for Windows) +1. All packages are in `/dist`, which includes two files(.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). ## 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 41176be971..70053f1aaa 100644 --- a/docs/en/How-to-release.md +++ b/docs/en/How-to-release.md @@ -1,16 +1,164 @@ Apache SkyWalking release guide -------------------- +This documents guide every committer to release SkyWalking in Apache Way, +and also help committers to check the release for vote. -Ref: -* http://tiles.apache.org/framework/dev/release.html -* http://www.apache.org/dev/publishing-maven-artifacts.html#dev-env - -Important things list: -* Maven releases, and the nexus staging repository, and download artifacts upload -* All artifacts are published with .asc, .md5, *sha1 files -* The *.asc files are signed with a gpg key that's part of apache's ring of trust -* Sync'ing this to releases and tags in github -* Making the internal announcements -* Calling a vote -* Moving the staging repository to a public repository, making download artifacts public -* Making the final public announcement \ No newline at end of file + +## SETUP YOUR DEVELOPMENT ENVIRONMENT +Use the following block as a template and place it in ~/.m2/settings.xml + +``` + +... + + + + apache.snapshots.https + + + + + + apache.releases.https + + + + ... + + +``` + +## TEST YOUR SETTINGS +``` +mvn clean install -Papache-release (this will build artifacts, sources and sign) +``` + +## PREPARE THE RELEASE +``` +mvn release:clean +mvn release:prepare +``` + +## STAGE THE RELEASE FOR A VOTE +``` +mvn release:perform +``` +The release will automatically be inserted into a temporary staging repository for you. + +## Build the source code package +TODO + +## Sign the distribution and source code package +TODO + +## Upload to Apache svn +TODO + + +## Make the internal announcements +Send an announcement mail in dev mail list. + +``` +Mail title: [ANNOUNCE] SkyWalking x.y.z test build available + +Mail content: +The test build of x.y.z is available. + +This is our Apache Incubator release. +We welcome any comments you may have, and will take all feedback into +account if a quality vote is called for this build. + +Release notes: + + * https://github.com/apache/incubator-skywalking/blob/master/CHANGELOG.md + +Release Candidate: + + * https://dist.apache.org/repos/dist/dev/incubator/skywalking/xxxx + +Maven 2 staging repository: + + * https://repository.apache.org/content/repositories/xxxx/org/apache/skywalking/ + +Release Tag : + + * (Git Tag) + +Release CommitID : + + * (Git Commit ID) + +Keys to verify the Release Candidate : + + * http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x2EF5026E70A55777 corresponding to pengys@apache.org + +Guide to build the release from source : + + * https://github.com/apache/incubator-skywalking/blob/master/docs/en/How-to-build.md + +A vote regarding the quality of this test build will be initiated +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. + +## Call a vote in dev +Call a vote in `dev@skywalking.apache.org` + +``` +Mail title: [VOTE] Release Apache SkyWalking (incubating) version x.y.z + +Mail content: +Hi All, +This is a call for vote to release Apache SkyWalking (Incubating) version x.y.z. + +Release notes: + + * https://github.com/apache/incubator-skywalking/blob/master/CHANGELOG.md + +Release Candidate: + + * https://dist.apache.org/repos/dist/dev/incubator/skywalking/xxxx + +Maven 2 staging repository: + + * https://repository.apache.org/content/repositories/xxxx/org/apache/skywalking/ + +Release Tag : + + * (Git Tag) + +Release CommitID : + + * (Git Commit ID) + +Keys to verify the Release Candidate : + + * http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x2EF5026E70A55777 corresponding to pengys@apache.org + +Guide to build the release from source : + + * https://github.com/apache/incubator-skywalking/blob/master/docs/en/How-to-build.md + +Voting will start now (xxxx date) and will remain open for at least 72 hours, Request all PPMC members to give their vote. +[ ] +1 Release this package. +[ ] +0 No opinion. +[ ] -1 Do not release this package because.... +``` + +## Vote Check +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. `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. + +## Call for a vote in Apache IPMC +Call a vote in `general@incubator.apache.org` \ No newline at end of file diff --git a/docs/en/Quick-start.md b/docs/en/Quick-start.md index 398ac04c19..d903af2c70 100644 --- a/docs/en/Quick-start.md +++ b/docs/en/Quick-start.md @@ -1,5 +1,5 @@ # Quick start -1. Download `org.apache.skywalking.apm-dist` in maven central. Or find `skywalking-dist.tar.gz/.zip` in `dist` folder after `mvn clean package`. +1. Download `apache-skywalking-apm-incubating-x.y.z.tar.gz` or `apache-skywalking-apm-incubating-x.y.z.zip` 1. Deploy Backend - [Standalone Mode](Deploy-backend-in-standalone-mode.md) - [Cluster Mode](Deploy-backend-in-cluster-mode.md) diff --git a/licenses/LICENSE-data-set b/licenses/LICENSE-data-set new file mode 100644 index 0000000000..80f9d60cd4 --- /dev/null +++ b/licenses/LICENSE-data-set @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 Alipay.inc + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/pom.xml b/pom.xml index 3ba7a610c8..b58c6a9921 100644 --- a/pom.xml +++ b/pom.xml @@ -144,27 +144,86 @@ - org.codehaus.mojo - exec-maven-plugin - 1.6.0 + org.apache.rat + apache-rat-plugin + 0.12 + + + **/target/** + **/DISCLAIMER + **/licenses/** + **/codeStyle.xml + + + **/*.iml + **/.idea/** + **/*.classpath + **/.project + **/.settings/** + **/dependency-reduced-pom.xml + + + **/.gitignore + **/.gitmodules + **/.git/** + + + **/.travis.yml + **/ci-dependencies/** + + + **/.github/** + + + **/*.md + **/*.MD + **/*.txt + **/docs/** + + + **/*.yml + **/*.config + + + **/*.graphqls + **/*.proto + + + **/src/test/resources/** + **/*.def + + + **/skywalking-ui/node_modules/** + **/skywalking-ui/node/** + **/skywalking-ui/.localized + **/skywalking-ui/.webpackrc.js + **/skywalking-ui/mock/.gitkeep + **/skywalking-ui/.ga + **/skywalking-ui/.eslintrc + **/skywalking-ui/.editorconfig + **/skywalking-ui/.stylelintrc + **/skywalking-ui/.roadhogrc.mock.js + **/skywalking-ui/dist/** + + + skywalking-ui/package.json + skywalking-ui/package-lock.json + + - git submodule update - initialize - false - - git - - submodule - update - --init - --recursive - - + verify - exec + check + + + + org.codehaus.mojo + exec-maven-plugin + 1.6.0 + install-jmxtools false @@ -335,6 +394,40 @@ + + travis-ci-submodule + + false + + + + + org.codehaus.mojo + exec-maven-plugin + 1.6.0 + + + git submodule update + initialize + false + + git + + submodule + update + --init + --recursive + + + + exec + + + + + + + install-ojdbc diff --git a/skywalking-ui b/skywalking-ui index 9c503a299a..25c2a7a05f 160000 --- a/skywalking-ui +++ b/skywalking-ui @@ -1 +1 @@ -Subproject commit 9c503a299aa3cba211e851e507d5625cc7cc0dd5 +Subproject commit 25c2a7a05f25c8844eb1128fdceed50d97bc4316 diff --git a/tools/releasing/create_source_release.sh b/tools/releasing/create_source_release.sh new file mode 100755 index 0000000000..a08f700d1c --- /dev/null +++ b/tools/releasing/create_source_release.sh @@ -0,0 +1,51 @@ +#!/usr/bin/env bash + +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# 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. +# + +## +## Variables with defaults (if not overwritten by environment) +## +RELEASE_VERSION=${RELEASE_VERSION} +PRODUCT_NAME="apache-skywalking-apm-incubating" + +if [ "$RELEASE_VERSION" == "" ]; then + echo "RELEASE_VERSION variable is null" + exit 1 +fi + +echo "Creating source package" + +PRODUCT_NAME=${PRODUCT_NAME}-${RELEASE_VERSION} + +rm -rf ${PRODUCT_NAME} +mkdir ${PRODUCT_NAME} + +rsync -a ../../ \ + --exclude ".git" --exclude ".gitignore" --exclude ".gitattributes" --exclude ".travis.yml" \ + --exclude "deploysettings.xml" --exclude "CHANGELOG" --exclude ".github" --exclude "target" \ + --exclude ".idea" --exclude "*.iml" --exclude ".DS_Store" --exclude "build-target" \ + --exclude "/docs/" --exclude "/dist/" --exclude "/tools/" --exclude "/skywalking-agent/" \ + --exclude "/skywalking-ui/dist/" --exclude "/skywalking-ui/node/" --exclude "/skywalking-ui/node_modules/" \ + ${PRODUCT_NAME} + +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 -- GitLab