You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kylin.apache.org by nj...@apache.org on 2019/01/09 06:15:25 UTC

[kylin] branch document updated: update how to release

This is an automated email from the ASF dual-hosted git repository.

nju_yaho pushed a commit to branch document
in repository https://gitbox.apache.org/repos/asf/kylin.git


The following commit(s) were added to refs/heads/document by this push:
     new ec78df6  update how to release
ec78df6 is described below

commit ec78df6b8ca1826e037df8eefd9bb3565ef4baa9
Author: kyotoYaho <nj...@apache.org>
AuthorDate: Wed Jan 9 14:09:13 2019 +0800

    update how to release
---
 website/_dev/howto_release.cn.md | 11 +++++++----
 website/_dev/howto_release.md    | 13 ++++++++-----
 2 files changed, 15 insertions(+), 9 deletions(-)

diff --git a/website/_dev/howto_release.cn.md b/website/_dev/howto_release.cn.md
index e7b1476..78f9c79 100644
--- a/website/_dev/howto_release.cn.md
+++ b/website/_dev/howto_release.cn.md
@@ -148,7 +148,7 @@ __准备__
 ssh -T git@github.com
 {% endhighlight %}
 
-基于要当前的开发分支,创建一个以 release 版本号命名的发布分支,例如,v2.5.0-release,并将其推到服务器端。  
+基于要当前的开发分支,创建一个以 release 版本号命名的发布分支,例如,v2.5.0-release (注意分支名字不能与tag名字相同),并将其推到服务器端。  
 {% highlight bash %}
 $ git checkout -b vX.Y.Z-release
 $ git push -u origin vX.Y.Z-release
@@ -183,6 +183,7 @@ __查看 dry run 输出:__
 __运行真实的 release:__
 现在真正开始 release  
 {% highlight bash %}
+# 如果之前做了dry run,在真正开始release之前需要做清理
 # Prepare sets the version numbers, creates a tag, and pushes it to git.
 $ mvn -DskipTests -DreleaseVersion=X.Y.Z -DdevelopmentVersion=(X.Y.Z+1)-SNAPSHOT -Papache-release -Darguments="-Dgpg.passphrase=${GPG_PASSPHRASE} -DskipTests" release:prepare
 
@@ -317,7 +318,7 @@ https://people.apache.org/keys/committer/lukehan.asc
 Please vote on releasing this package as Apache Kylin X.Y.Z.
 
 The vote is open for the next 72 hours and passes if a majority of
-at least three +1 PPMC votes are cast.
+at least three +1 PMC votes are cast.
 
 [ ] +1 Release this package as Apache Kylin X.Y.Z
 [ ]  0 I don't feel strongly about it, but I'm okay with the release
@@ -432,9 +433,11 @@ svn commit -m 'Remove old release'
 
 
 ## 更新源码
-发布后,您需要手动更新一些源代码:
+发布后,您需要更新一些源代码:
 
-* 更新 `KylinVersion` 类,将 `CURRENT_KYLIN_VERSION` 的值更改为当前开发版本。
+* 把分布分支,如v2.5.0-release,合并到开发分支中,如2.5.x,以便开始下个版本的开发。
+
+* 手动更新 `KylinVersion` 类,将 `CURRENT_KYLIN_VERSION` 的值更改为当前开发版本。
 
 ## 发布网站  
 更多细节参考[如何写文档](howto_docs.html)。
diff --git a/website/_dev/howto_release.md b/website/_dev/howto_release.md
index 5c0477b..2548eac 100644
--- a/website/_dev/howto_release.md
+++ b/website/_dev/howto_release.md
@@ -149,7 +149,7 @@ Make sure your can ssh connection to github:
 ssh -T git@github.com
 {% endhighlight %}
 
-Create a branch for release work from your current development branch, named with this release version, e.g. v2.5.0-release, and then push it to Apache.  
+Create a branch for release work from your current development branch, named with this release version, e.g. v2.5.0-release (should not be the same name with the tag name), and then push it to Apache.  
 {% highlight bash %}
 $ git checkout -b vX.Y.Z-release
 $ git push -u origin vX.Y.Z-release
@@ -185,6 +185,7 @@ __Check the dry run output:__
 __Run real release:__
 Now, run the release for real.  
 {% highlight bash %}
+# Note that if a dry run is done previously, need to do the cleanup first before run the release for real
 # Prepare sets the version numbers, creates a tag, and pushes it to git.
 $ mvn -DskipTests -DreleaseVersion=X.Y.Z -DdevelopmentVersion=(X.Y.Z+1)-SNAPSHOT -Papache-release -Darguments="-Dgpg.passphrase=${GPG_PASSPHRASE} -DskipTests" release:prepare
 
@@ -307,7 +308,7 @@ Its hash is xxx.
 The artifacts to be voted on are located here:
 https://dist.apache.org/repos/dist/dev/kylin/apache-kylin-X.Y.Z-rcN/
 
-The hashe of the artifact is as follows:
+The hash of the artifact is as follows:
 apache-kylin-X.Y.Z-source-release.zip.sha256 xxx
 
 A staged Maven repository is available for review at:
@@ -319,7 +320,7 @@ https://people.apache.org/keys/committer/lukehan.asc
 Please vote on releasing this package as Apache Kylin X.Y.Z.
 
 The vote is open for the next 72 hours and passes if a majority of
-at least three +1 PPMC votes are cast.
+at least three +1 PMC votes are cast.
 
 [ ] +1 Release this package as Apache Kylin X.Y.Z
 [ ]  0 I don't feel strongly about it, but I'm okay with the release
@@ -437,9 +438,11 @@ After publish the release, you need generate the binary packages and then put th
 
 
 ## Update source code
-After publish the release, you need to manually update some source code:
+After publish the release, you need to do update some source code:
 
-* Update `KylinVersion` class, change value of `CURRENT_KYLIN_VERSION` to current development version. 
+* Merge the release branch, e.g. v2.5.0-release, to the current development branch, e.g. 2.5.x, for preparing the next development iteration.
+
+* Manually update `KylinVersion` class, change value of `CURRENT_KYLIN_VERSION` to current development version. 
 
 ## Publishing the web site  
 Refer to [How to document](howto_docs.html) for more detail.