You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by do...@apache.org on 2023/03/21 02:17:09 UTC
[inlong-website] branch master updated: [INLONG-729][Doc] Update the how-to-release guide (#730)
This is an automated email from the ASF dual-hosted git repository.
dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new 8764f0b6e3 [INLONG-729][Doc] Update the how-to-release guide (#730)
8764f0b6e3 is described below
commit 8764f0b6e38302c79cae4fcb0a2140d60e2e95e5
Author: Charles Zhang <do...@apache.org>
AuthorDate: Tue Mar 21 10:17:03 2023 +0800
[INLONG-729][Doc] Update the how-to-release guide (#730)
---
community/how-to-release.md | 22 +++++++++++----------
.../current/how-to-release.md | 23 ++++++++++++----------
2 files changed, 25 insertions(+), 20 deletions(-)
diff --git a/community/how-to-release.md b/community/how-to-release.md
index bee0e47d1b..034ef88f3c 100644
--- a/community/how-to-release.md
+++ b/community/how-to-release.md
@@ -173,10 +173,12 @@ Adding `<servers>/<profiles>` configurations in your maven `settings.xml` with c
The following `release_version` is the upcoming release number, such as 1.4.0; `rc_version` is Release Candidate, such as RC0, RC1...; `KEY_ID` is your GPG Key ID.
### Prepare branch
-- Create the release branch from the main version branch and modify the POM version number and CHANGES.md. For example, create `release-1.4.0` from `branch-1.4`
+- Create the release branch from the main version branch and modify the POM version number and CHANGES.md. For example, create `release-1.4.0` from `branch-1.4`.
-- check the code, including whether compile, unit test, RAT check, Docker images etc.
+- check the code for release branch, including whether compile, unit test, RAT check, Docker images etc.
```shell
+# switch to release branch
+$ git checkout release-${release_version}
# build check
$ mvn clean package -Dmaven.javadoc.skip=true
# RAT check
@@ -203,6 +205,13 @@ $ mkdir /tmp/apache-inlong-${release_version}-${rc_version}
$ git archive --format=tar.gz --output="/tmp/apache-inlong-${release_version}-${rc_version}/apache-inlong-${release_version}-src.tar.gz" --prefix="apache-inlong-${release_version}/" $git_tag
```
+### Upload tag to git repository
+```shell
+# under the directory where you create the tag
+$ git push origin ${release_version}-${rc_version}
+$ git push origin release-${release_version}
+```
+
### Building binary package
```shell
# go to directory where the source code package stay
@@ -244,13 +253,6 @@ $ cd /tmp/apache-inlong-${release_version}-${rc_version}/apache-inlong-${release
$ mvn -DskipTests deploy -Papache-release -Dmaven.javadoc.skip=true
```
-### Upload tag to git repository
-```shell
-# under the directory where you create the tag
-$ git push origin ${release_version}-${rc_version}
-$ git push origin release-${release_version}
-```
-
### Upload tar file to dist repo
- Checkout dist repo to local directory
```shell
@@ -449,7 +451,7 @@ $ rm -rf /tmp/inlong-dist-dev/
```
### Archive the previous version packages
-Delete release package of previous versions [release](https://dist.apache.org/repos/dist/release/inlong/)，these packages will be saved [here](https://archive.apache.org/dist/inlong/)
+Delete release package of previous versions [release](https://dist.apache.org/repos/dist/release/inlong/)，these packages will be saved [here](https://archive.apache.org/dist/inlong/).
```shell
# last_release_version is the last version number, you can check is by accessing https://dist.apache.org/repos/dist/release/inlong/ ,e.g 1.3.0
$ svn delete https://dist.apache.org/repos/dist/release/inlong/${last_release_version} -m "Delete ${last_release_version}"
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-release.md b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-release.md
index 1d57ef1f07..1b568eb6cf 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-release.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-release.md
@@ -172,10 +172,12 @@ $ svn ci -m "add gpg key for YOUR_NAME"
以下 `release_version` 为即将发布的版本号，比如 1.4.0；`rc_version` 为 Releae Candidate，比如 RC0，RC1...;`KEY_ID` 是你创建的 GPG Key ID.
### 准备分支
-- 从版本主分支创建待发布分支，并修改 POM 版本号和 CHANGES.md。比如从 `branch-1.4` 创建 `release-1.4.0`
+- 从版本主分支创建待发布分支，并修改 POM 版本号和 CHANGES.md。比如从 `branch-1.4` 创建 `release-1.4.0`。
-- 检查代码是否正常，包括编译成功、单元测试全部成功、RAT 检查、Docker 镜像等
+- 检查 release 分支代码是否正常，包括编译成功、单元测试全部成功、RAT 检查、Docker 镜像等
```shell
+# 切换放到 release 分支
+$ git checkout release-${release_version}
# build 检查
$ mvn clean package -Dmaven.javadoc.skip=true
# RAT 检查
@@ -195,12 +197,20 @@ $ git_tag=${release_version}-${rc_version}
$ export GPG_TTY=`tty` && git config user.signingkey ${KEY_ID}
$ git tag -s $git_tag -m "Tagging the ${release_version} first Releae Candidate (Candidates start at zero)"
```
+
### 打包源码
```shell
$ mkdir /tmp/apache-inlong-${release_version}-${rc_version}
$ git archive --format=tar.gz --output="/tmp/apache-inlong-${release_version}-${rc_version}/apache-inlong-${release_version}-src.tar.gz" --prefix="apache-inlong-${release_version}/" $git_tag
```
+### 上传 tag 到 git 仓库
+```shell
+# 在创建 tag 的源码目录执行
+$ git push origin ${release_version}-${rc_version}
+$ git push origin release-${release_version}
+```
+
### 打包二进制包
```shell
# 进入源码包目录
@@ -241,13 +251,6 @@ $ cd /tmp/apache-inlong-${release_version}-${rc_version}/apache-inlong-${release
$ mvn -DskipTests deploy -Papache-release -Dmaven.javadoc.skip=true
```
-### 上传 tag 到 git 仓库
-```shell
-# 在创建 tag 的源码目录执行
-$ git push origin ${release_version}-${rc_version}
-$ git push origin release-${release_version}
-```
-
### 上传编译好的文件到 dist
- 将 dist 仓库 checkout 到本地目录
```shell
@@ -444,7 +447,7 @@ $ rm -rf /tmp/inlong-dist-dev/
```
### 归档上一个版本的发布包
-删除 [release](https://dist.apache.org/repos/dist/release/inlong/) 目录下上一个版本的发布包，这些包会被自动保存在[这里](https://archive.apache.org/dist/inlong/)
+删除 [release](https://dist.apache.org/repos/dist/release/inlong/) 目录下上一个版本的发布包，这些包会被自动保存在[这里](https://archive.apache.org/dist/inlong/)。
```shell
# last_release_version 为上一个版本号，可以访问 https://dist.apache.org/repos/dist/release/inlong/ 查看，比如 1.3.0
$ svn delete https://dist.apache.org/repos/dist/release/inlong/${last_release_version} -m "Delete ${last_release_version}"