This is an automated email from the ASF dual-hosted git repository.
gosonzhang 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 e264d020f [INLONG-4710][Website] Modify how to release and verify
(#450)
e264d020f is described below
commit e264d020fb0a1a2a7f55b486b5d11e135d6ffb1d
Author: gosonzhang <[email protected]>
AuthorDate: Fri Jun 24 09:50:26 2022 +0800
[INLONG-4710][Website] Modify how to release and verify (#450)
---
community/how-to-release.md | 154 ++++--------
community/how-to-verify.md | 10 +-
.../current/how-to-release.md | 258 ++++++++-------------
.../current/how-to-verify.md | 34 ++-
4 files changed, 152 insertions(+), 304 deletions(-)
diff --git a/community/how-to-release.md b/community/how-to-release.md
index 71f7a501c..d3917f406 100644
--- a/community/how-to-release.md
+++ b/community/how-to-release.md
@@ -13,9 +13,10 @@ Note that for binary distribution packages, it is necessary
to check that the ne
For more guideline, you can refer the following links:
-[Apache Release
Guide](https://incubator.apache.org/guides/releasemanagement.html)
+[ASF Release Creation
Process](https://infra.apache.org/release-publishing.html)
+
+[ASF Release Policy](https://www.apache.org/legal/release-policy.html)
-[Apache incubator official website](https://incubator.apache.org/)
## Adding PG KEY
> Ref：https://infra.apache.org/openpgp.html
@@ -118,11 +119,11 @@ Uploading takes about one minute, after that, you can
check by your email at `ht
### Add your gpg public key to the KEYS document
> SVN is required for this step
-The svn repository of the DEV branch is:
https://dist.apache.org/repos/dist/dev/incubator/inlong
-The svn repository of the Release branch is:
https://dist.apache.org/repos/dist/release/incubator/inlong
+The svn repository of the DEV branch is:
https://dist.apache.org/repos/dist/dev/inlong
+The svn repository of the Release branch is:
https://dist.apache.org/repos/dist/release/inlong
#### Add the public key to KEYS in the dev branch to release the RC version
```shell
-➜ ~ svn co https://dist.apache.org/repos/dist/dev/incubator/inlong
/tmp/inlong-dist-dev
+➜ ~ svn co https://dist.apache.org/repos/dist/dev/inlong /tmp/inlong-dist-dev
# As this step will copy all the versions, it will take some time. If the
network is broken, please use svn cleanup to delete the lock before re-execute
it.
➜ ~ cd inlong-dist-dev
➜ inlong-dist-dev ~ (gpg --list-sigs [email protected] && gpg --export
--armor [email protected]) >> KEYS # Append your key to the KEYS file
@@ -132,7 +133,7 @@ The svn repository of the Release branch is:
https://dist.apache.org/repos/dist/
#### Add the public key to the KEYS in the release branch for releasing
official version
```shell
-➜ ~ svn co https://dist.apache.org/repos/dist/release/incubator/inlong
/tmp/inlong-dist-release
+➜ ~ svn co https://dist.apache.org/repos/dist/release/inlong
/tmp/inlong-dist-release
➜ ~ cd inlong-dist-release
➜ inlong-dist-release ~ (gpg --list-sigs [email protected] && gpg --export
--armor [email protected]) >> KEYS # Append the KEY you generated to the
document KEYS, after appending, it is best to check whether it is correct
➜ inlong-dist-release ~ svn add . # It is not needed if the KEYS document
exists before.
@@ -251,12 +252,12 @@ git push origin ${release_version}-${rc_version}
```
### Upload tar file to dist repo
-> SVN is need in this step, SVN repo for DEV branch is
https://dist.apache.org/repos/dist/dev/incubator/inlong
+> SVN is need in this step, SVN repo for DEV branch is
https://dist.apache.org/repos/dist/dev/inlong
### Checkout InLong to local directory
```shell
# As this step will copy all the versions, it will take some time. If the
network is broken, please use svn cleanup to delete the lock before re-execute
it.
-svn co https://dist.apache.org/repos/dist/dev/incubator/inlong
/tmp/inlong-dist-dev
+svn co https://dist.apache.org/repos/dist/dev/inlong /tmp/inlong-dist-dev
```
### Add public key to KEYS file adn commit to SVN repository
@@ -281,10 +282,8 @@ svn commit -m "prepare for ${release_version}
${rc_version}" # commit to SVN
WARN: Close operation may fail, you should check the causes and fix them.
## Voting
-> A release need two votes due to InLong is still an incubating project now.
+> InLong has graduated and only needs to vote once now.
- InLong community vote，send email to ：`[email protected]`
-- incubator community vote，send email to：`[email protected]`
-Once InLong is graduated, InLong community vote is only needed.
### InLong community vote
@@ -295,17 +294,17 @@ Title：[VOTE] Release Apache InLong ${release_version}
${rc_version}
Content：
-Hello Apache InLong PPMC and Community,
+Hello Apache InLong PMC and Community,
This is a call for a vote to release Apache InLong version
${release_version}-${rc_version}.
The tag to be voted on is ${release_version}-${rc_version}:
-
https://github.com/apache/incubator-inlong/tree/${release_version}-${rc_version}
+ https://github.com/apache/inlong/tree/${release_version}-${rc_version}
The release tarball, signature, and checksums can be found at:
-
https://dist.apache.org/repos/dist/dev/incubator/inlong/${release_version}-${rc_version}/
+
https://dist.apache.org/repos/dist/dev/inlong/${release_version}-${rc_version}/
Maven artifacts are available in a staging repository at:
@@ -313,11 +312,11 @@ Hello Apache InLong PPMC and Community,
Artifacts were signed with the {YOUR_PUB_KEY} key which can be found in:
- https://downloads.apache.org/incubator/inlong/KEYS
+ https://downloads.apache.org/inlong/KEYS
${release_version} includes ~ ${issue_count} bug fixes and improvements
done since last versions which can be found at:
-
https://github.com/apache/incubator-inlong/blob/${release_version}-${rc_version}/CHANGES.md
+
https://github.com/apache/inlong/blob/${release_version}-${rc_version}/CHANGES.md
Please download, verify, and test.
@@ -334,14 +333,14 @@ Hello Apache InLong PPMC and Community,
[ ] Download links are valid.
[ ] Checksums and signatures.
- [ ] LICENSE/NOTICE/DISCLAIMER files exist
+ [ ] LICENSE/NOTICE files exist
[ ] No unexpected binary files
[ ] All source files have ASF headers
[ ] Can compile from source
[ ] All Tests Passed
More detailed checklist please refer to:
-
https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist
+ https://inlong.apache.org/community/how-to-verify
Thanks,
Your InLong Release Manager
@@ -353,112 +352,33 @@ Title：[RESULT][VOTE] Release Apache InLong
${release_version} ${rc_version}
Content：
-Hello Apache InLong PPMC and Community,
+Hello Apache InLong PMC and Community,
The vote closes now as 72hr have passed. The vote PASSES with
- xx (+1 non-binding) votes from the PPMC,
- xx (+1 binding) vote from the IPMC,
+ xx (+1 non-binding) votes from the PMC,
xx (+1 non-binding) vote from the rest of the developer community,
and no further 0 or -1 votes.
The vote thread: {vote_mail_address}
- I will now bring the vote to [email protected] to get approval
by the IPMC.
- If this vote passes also, the release is accepted and will be published.
+ The release is accepted and will be published.
Thank you for your support.
Your InLong Release Manager
```
-### incubator community vote
-
-#### Vote template
-
-```html
-Title：[VOTE] Release Apache InLong(Incubating) ${release_version} ${rc_version}
-
-Content：
-
-Hello Incubator Community,
-
- This is a call for a vote to release Apache InLong(Incubating) version
- ${release_version} ${rc_version}
-
- The Apache InLong community has voted on and approved a proposal to release
- Apache InLong(Incubating) version ${release_version} ${rc_version}
-
- We now kindly request the Incubator PMC members review and vote on this
- incubator release.
-
- InLong community vote thread:
- • [Link for vote thread]
-
- Vote result thread:
- • [Link for vote result thread]
-
- The release candidate:
- •
https://dist.apache.org/repos/dist/dev/incubator/inlong/${release_version}-${rc_version}/
-
- Git tag for the release:
- •
https://github.com/apache/incubator-inlong/releases/tag/${release_version}-${rc_version}
-
- Release notes:
- •
https://github.com/apache/incubator-inlong/blob/${release_version}-${rc_version}/CHANGES.md
-
- The artifacts signed with PGP key [your personal KEY], corresponding to
[your email], that can be found in keys file:
- • https://downloads.apache.org/incubator/inlong/KEYS
-
- The vote will be open for at least 72 hours or until necessary number of
votes are reached.
-
- Please vote accordingly:
-
- [ ] +1 approve
- [ ] +0 no opinion
- [ ] -1 disapprove with the reason
-
-Thanks,
-On behalf of Apache InLong(Incubating) community
-
-```
-
-#### Vote Result template
-```html
-Title：[RESULT][VOTE] Release Apache InLong ${release_version} {rc_version}
-
-Content：
-Hi all
-
-Thanks for reviewing and voting for Apache InLong(Incubating)
${release_version} {rc_version}
-release, I am happy to announce the release voting has passed with [vote
result count]
-binding votes, no +0 or -1 votes. Binding votes are from IPMC
-
- - xxx
- - xxx
- - xxx
-
-The voting thread is:
-[Link for vote thread]
-
-Many thanks for all our mentors helping us with the release procedure, and
-all IPMC helped us to review and vote for Apache InLong(Incubating) release. I
will
-be working on publishing the artifacts soon.
-
-Thanks
-On behalf of Apache InLong(Incubating) community
-```
-
## Officially released
### Merge branch release-${release_version} to master branch
### Move source code and binary package from DEV to release repository on SVN.
```shell
-svn mv
https://dist.apache.org/repos/dist/dev/incubator/inlong/${release_version}-${rc_version}
https://dist.apache.org/repos/dist/release/incubator/inlong/${release_version}
-m "Release ${release_version}"
+svn mv
https://dist.apache.org/repos/dist/dev/inlong/${release_version}-${rc_version}
https://dist.apache.org/repos/dist/release/inlong/${release_version} -m
"Release ${release_version}"
```
### Check whether the dev and release is correct
-1. Make sure
[dev](https://dist.apache.org/repos/dist/dev/incubator/inlong/)下的`${release_version}-${rc_version}`
is deleted
-2. Delete release package of pre
versions[release](https://dist.apache.org/repos/dist/release/incubator/inlong/)，these
packages will be saved
[here](https://archive.apache.org/dist/incubator/inlong/)
+1. Make sure `${release_version}-${rc_version}` is deleted in
[dev](https://dist.apache.org/repos/dist/dev/inlong/).
+2. Delete release package of pre
versions[release](https://dist.apache.org/repos/dist/release/inlong/)，these
packages will be saved [here](https://archive.apache.org/dist/inlong/)
```shell
-svn delete
https://dist.apache.org/repos/dist/release/incubator/inlong/${last_release_version}
-m "Delete ${last_release_version}"
+svn delete
https://dist.apache.org/repos/dist/release/inlong/${last_release_version} -m
"Delete ${last_release_version}"
```
### Release version in Apache Staging
@@ -472,32 +392,40 @@ svn delete
https://dist.apache.org/repos/dist/release/incubator/inlong/${last_re
### Update links on official website
-### Send email to `[email protected]` and `[email protected]`
+### Send email to `[email protected]` and CC `[email protected]`
**Please make sure deployment in step 6.4 is successfully, and generally wait
24 hours between 6.4 and send emails**
Release announce email template：
```html
-Title： [ANNOUNCE] Release Apache InLong(incubating) ${release_version}
+Title： [ANNOUNCE] Release Apache InLong ${release_version}
Content：
Hi all,
-The Apache InLong(incubating) community is pleased to announce
-that Apache InLong(incubating) ${release_version} has been released!
+The Apache InLong community is pleased to announce
+that Apache InLong ${release_version} has been released!
Apache InLong is a one-stop integration framework for massive data that
provides automatic, secure,
distributed, and efficient data publishing and subscription capabilities.
This platform helps you easily build stream-based data applications.
-Download Links: https://inlong.apache.org/download/main
+This release contains a number of new features, bug fixes and
+improvements compared to the last version released before.
+The notable changes since ${release_version} include:
+1. xxxxx
+2. yyyyyy
+3. zzzzzz
-Release Notes: https://inlong.apache.org/download/release-${release_version}
+Please refer to the change log for the complete list of changes:
+https://github.com/apache/inlong/blob/${release_version}-${rc_version}/CHANGES.md
-Website: https://inlong.apache.org/
+Apache InLong website: https://inlong.apache.org/
+
+Download Links: https://inlong.apache.org/download/main
InLong Resources:
-- Issue: https://github.com/apache/incubator-inlong/issues
+- Issue: https://github.com/apache/inlong/issues
- Mailing list: [email protected]
Thanks
-On behalf of Apache InLong(Incubating) community
+On behalf of Apache InLong community
```
diff --git a/community/how-to-verify.md b/community/how-to-verify.md
index 24ba84275..0064bf257 100644
--- a/community/how-to-verify.md
+++ b/community/how-to-verify.md
@@ -6,19 +6,17 @@ sidebar_position: 7
To verify the release, the following checklist can be used to reference:
- [ ] Download links are valid.
- [ ] Checksums and PGP signatures are valid.
-- [ ] DISCLAIMER is included.
- [ ] Source code artifacts have correct names matching the current release.
- [ ] LICENSE and NOTICE files are correct for the repository.
- [ ] All files have license headers if necessary.
- [ ] No compiled archives bundled in source archive.
- [ ] Building is OK.
-For a detailed checklist, please refer to [check
list](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist),
here we introduce how to do the verification.
## Download the release package to be verified to the local environment
> Use the following command to download all artifacts, replace
> "${release_version}-${rc_version}" with the version ID of the version to be
> released:
```shell
-svn co
https://dist.apache.org/repos/dist/dev/incubator/inlong/${release_version}-${rc_version}/
+svn co
https://dist.apache.org/repos/dist/dev/inlong/${release_version}-${rc_version}/
```
## Verify signature and hash
@@ -36,7 +34,7 @@ The package to release must check:
GnuPG is recommended, which can install by yum install GnuPG or apt-get
install GnuPG.
- Import public key
```shell
- curl https://dist.apache.org/repos/dist/dev/incubator/inlong/KEYS > KEYS #
Download KEYS
+ curl https://downloads.apache.org/inlong/KEYS > KEYS # Download KEYS
gpg --import KEYS # Import KEYS to local
```
- Trust the public key
@@ -105,7 +103,7 @@ GnuPG is recommended, which can install by yum install
GnuPG or apt-get install
- Confirm result
> If something similar to the following appears, it means that the signature
is correct, and the keywords: **`Good signature`**
```shell
-apache-inlong-0.3.0-incubating-src.tar.gz
+apache-inlong-1.3.0-src.tar.gz
gpg: Signature made Sat May 30 11:45:01 2020 CST
gpg: using RSA key 9B12C2228BDFF4F4CFE849445EF3A66D57EC647A
gpg: Good signature from "Guangxu Cheng <[email protected]>" [ultimate]gular2
@@ -126,7 +124,6 @@ for i in *.tar.gz.sha512; do echo $i; sha512sum -c $i; done
### Check the file content of the source package
Unzip `apache-inlong-${release_version}-src.tar.gz` and check as follows:
-- [ ] DISCLAIMER file exists and the content is correct.
- [ ] LICENSE and NOTICE files are correct for the repository.
- [ ] All files have ASF license headers if necessary.
- [ ] The source code can be compiled normally.
@@ -142,7 +139,6 @@ Attentions:
### Check the binary package (if the binary package is included)
Unzip `apache-inlong-client-${release_version}-src.tar.gz` and `
apache-inlong-server-${release_version}-src.tar.gz`, check as follows:
-- [ ] DISCLAIMER file exists and the content is correct.
- [ ] LICENSE and NOTICE files are correct for the repository.
- [ ] The deployment can be successful
- [ ] Deploy a test environment to verify whether production and consumption
can run normally.
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 6bb11cedc..4cd42e305 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
@@ -3,33 +3,33 @@ title: 如何发布版本
sidebar_position: 6
---
-> 本文主要介绍了Release Manager如何按照Apache的流程发布版本，
+> 本文主要介绍了 Release Manager 如何按照 Apache 的流程发布版本，
-Source Release是Apache关注的重点，也是发布的必须内容；
-Binary Release是可选项，InLong可以选择是否发布二进制包到Apache仓库或者发布到Maven中央仓库。
+Source Release 是 Apache 关注的重点，也是发布的必须内容；
+Binary Release 是可选项，InLong 可以选择是否发布二进制包到 Apache 仓库或者发布到 Maven 中央仓库。
-注意，对于二进制发布包，需要检查新版本里是否包含了x类的第三方依赖包，包括直接引用和间接引用部分，如果包含了，需要去掉后再发布版本
+注意，对于二进制发布包，需要检查新版本里是否包含了 x类 的第三方依赖包，包括直接引用和间接引用部分，如果包含了，需要去掉后再发布版本
-请参考以下链接，找到更多关于ASF的发布指南:
+相关说明和工具将遵守 ASF 的版本发布指南及 ASF 的发布政策，具体详情请参考以下链接:
-[Apache Release
Guide](https://incubator.apache.org/guides/releasemanagement.html)
+[ASF 版本创建过程](https://infra.apache.org/release-publishing.html)
-[Apache incubator 官网](https://incubator.apache.org/)
+[ASF 发布政策](https://www.apache.org/legal/release-policy.html)
-## 添加GPG KEY
+## 添加 GPG KEY
> 本章节主要参考：https://infra.apache.org/openpgp.html
-**该章节仅仅对第一次当该项目的Release Manager需要。**
+**该章节仅仅对第一次当该项目的 Release Manager 需要。**
-### 安装gpg
-详细的安装文档可以参考[官网](https://www.gnupg.org/download/index.html), Mac OS环境配置如下
+### 安装 gpg
+详细的安装文档可以参考[官网](https://www.gnupg.org/download/index.html), Mac OS 环境配置如下
```shell
$ brew install gpg
$ gpg --version #检查版本，应该为2.x
```
-### 生成gpg Key
+### 生成 gpg Key
#### 需要注意以下几点：
-- 输入名字时最好与Apache中登记的Full name保持一致
-- 使用的邮箱应该是apache邮箱
+- 输入名字时最好与 Apache 中登记的 Full name 保持一致
+- 使用的邮箱应该是 apache 邮箱
- 名字最好使用拼音或者英文，否则会出现乱码
#### 根据提示，生成key
@@ -96,7 +96,7 @@ uid Guangxu Cheng <[email protected]>
sub rsa4096 2020-05-19 [E]
```
-### 上传生成的key到公共服务器
+### 上传生成的 key 到公共服务器
```shell
➜ ~ gpg --list-keys
@@ -111,7 +111,7 @@ $ gpg --keyserver pgpkeys.mit.edu --send-key <key id>
#
其中，pgpkeys.mit.edu为随意挑选的keyserver，keyserver列表为：https://sks-keyservers.net/status/，为相互之间是自动同步的，选任意一个都可以。
```
-### 查看key是否创建成功
+### 查看 key 是否创建成功
通过下面的网址，使用邮箱查询上传成功没，大概需要一分钟才能查到，查询时候把 advance 下边的 show full-key hashes 勾上
http://keys.gnupg.net
@@ -119,18 +119,18 @@ http://keys.gnupg.net
-### 将你的gpg公钥加入KEYS文件
+### 将你的 gpg 公钥加入 KEYS 文件
-> 这个步骤需要使用SVN
+> 这个步骤需要使用 SVN
-DEV分支的svn库是 https://dist.apache.org/repos/dist/dev/incubator/inlong
+DEV 分支的 svn 库是 https://dist.apache.org/repos/dist/dev/inlong
-Release分支的SVN库是 https://dist.apache.org/repos/dist/release/incubator/inlong
+Release 分支的 SVN 库是 https://dist.apache.org/repos/dist/release/inlong
-#### 在dev分支中添加公钥到KEYS，用于发布RC版本
+#### 在 dev 分支中添加公钥到 KEYS，用于发布 RC 版本
```shell
-➜ ~ svn co https://dist.apache.org/repos/dist/dev/incubator/inlong
/tmp/inlong-dist-dev
+➜ ~ svn co https://dist.apache.org/repos/dist/dev/inlong /tmp/inlong-dist-dev
# 这个步骤比较慢，会把所有版本都拷贝下来，如果网断了，用svn cleanup删掉锁，重新执行一下，会断点续传
➜ ~ cd inlong-dist-dev
➜ inlong-dist-dev ~ (gpg --list-sigs [email protected] && gpg --export
--armor [email protected]) >> KEYS # 追加你生成的KEY到文件KEYS中, 追加后最好检查一下是否正确
@@ -138,26 +138,26 @@ Release分支的SVN库是
https://dist.apache.org/repos/dist/release/incubator/i
➜ inlong-dist-dev ~ svn ci -m "add gpg key for YOUR_NAME" #
接下来会要求输入用户名和密码，就用你的apache的用户名和密码。
```
-#### 在release分支中添加公钥到KEYS，用于发布正式版本
+#### 在 release 分支中添加公钥到 KEYS，用于发布正式版本
```shell
-➜ ~ svn co https://dist.apache.org/repos/dist/release/incubator/inlong
/tmp/inlong-dist-release
+➜ ~ svn co https://dist.apache.org/repos/dist/release/inlong
/tmp/inlong-dist-release
➜ ~ cd inlong-dist-release
➜ inlong-dist-release ~ (gpg --list-sigs [email protected] && gpg --export
--armor [email protected]) >> KEYS # 追加你生成的KEY到文件KEYS中, 追加后最好检查一下是否正确
➜ inlong-dist-release ~ svn add . # 如果之前存在KEYS文件，则不需要
➜ inlong-dist-release ~ svn ci -m "add gpg key for YOUR_NAME" #
接下来会要求输入用户名和密码，就用你的apache的用户名和密码。
```
-### 上传GPG公钥到Github账户
+### 上传 GPG 公钥到 Github 账户
-1. 进入 https://github.com/settings/keys ，添加GPG KEYS。
-2. 如果添加后你发现这个密钥后面写了“未经过验证” (unverified)，记得去将GPG key中用到的邮箱绑定到你的github账户上
(https://github.com/settings/emails)。
+1. 进入 https://github.com/settings/keys ，添加 GPG KEYS。
+2. 如果添加后你发现这个密钥后面写了“未经过验证” (unverified)，记得去将 GPG key 中用到的邮箱绑定到你的 github 账户上
(https://github.com/settings/emails)。
-## 设置maven设置
+## 设置 maven 设置
**如果已经设置过则跳过**
-在maven的配置文件~/.m2/settings.xml中，则添加下面的`<server>`项
+在 maven 的配置文件 ~/.m2/settings.xml 中，则添加下面的 `<server>` 项
```xml
<?xml version="1.0" encoding="UTF-8"?>
<settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0
http://maven.apache.org/xsd/settings-1.1.0.xsd";
xmlns="http://maven.apache.org/SETTINGS/1.1.0";
@@ -193,9 +193,9 @@ Release分支的SVN库是
https://dist.apache.org/repos/dist/release/incubator/i
### 准备分支
- 从主干分支拉取新分支作为发布分支，release-${release_version}
- - 更新`CHANGES.md`
+ - 更新 `CHANGES.md`
- - 检查代码是否正常，包括编译成功、单元测试全部成功，RAT检查成功等等
+ - 检查代码是否正常，包括编译成功、单元测试全部成功，RAT 检查成功等等
```shell
# build检查
@@ -207,10 +207,10 @@ Release分支的SVN库是
https://dist.apache.org/repos/dist/release/incubator/i
- 更改版本号
-### 创建tag
-> 创建tag前，要确保代码已经检查无误，包括：编译成功、单元测试全部成功，RAT检查成功等
+### 创建 tag
+> 创建 tag 前，要确保代码已经检查无误，包括：编译成功、单元测试全部成功，RAT 检查成功等
-**创建一个带签名的tag**
+**创建一个带签名的 tag **
```shell
$ git_tag=${release_version}-${rc_version}
$ git tag -s $git_tag -m "Tagging the ${release_version} first Releae
Candidate (Candidates start at zero)"
@@ -219,7 +219,7 @@ $ git config user.signingkey ${KEY_ID}
```
### 打包源码
-> tag创建成功后，我需要将tag源码打包成一个tar包
+> tag创建成功后，我需要将 tag 源码打包成一个 tar 包
```shell
mkdir /tmp/apache-inlong-${release_version}-${rc_version}
@@ -249,8 +249,8 @@ for i in *.tar.gz; do echo $i; gpg --armor --output $i.asc
--detach-sig $i ; don
```shell
for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done
```
-## 准备Apache发布
-### 发布jar包到Apache Nexus仓库
+## 准备 Apache 发布
+### 发布 jar 包到 Apache Nexus 仓库
```shell
cd /tmp/apache-inlong-${release_version}-${rc_version} # 进入源码包目录
tar xzvf apache-inlong-${release_version}-src.tar.gz #解压源码包
@@ -258,22 +258,22 @@ cd apache-inlong-${release_version}
mvn -DskipTests deploy -Papache-release -Dmaven.javadoc.skip=true # 开始上传
```
-### 上传tag到git仓库
+### 上传 tag 到 git 仓库
```shell
git push origin ${release_version}-${rc_version}
```
-### 上传编译好的文件到dist
-> 这个步骤需要使用SVN, DEV分支的svn库是
https://dist.apache.org/repos/dist/dev/incubator/inlong
+### 上传编译好的文件到 dist
+> 这个步骤需要使用 SVN, DEV 分支的 svn 库是 https://dist.apache.org/repos/dist/dev/inlong
-### 将InLong checkout到本地目录
+### 将 InLong checkout 到本地目录
```shell
-# 这个步骤可能会比较慢，会把所有版本都考下来，如果网断了，用svn cleanup删掉锁，重新执行一下，会断点续传
-svn co https://dist.apache.org/repos/dist/dev/incubator/inlong
/tmp/inlong-dist-dev
+# 这个步骤可能会比较慢，会把所有版本都考下来，如果网断了，用 svn cleanup 删掉锁，重新执行一下，会断点续传
+svn co https://dist.apache.org/repos/dist/dev/inlong /tmp/inlong-dist-dev
```
-### 添加public key到KEYS文件并提交到SVN仓库
+### 添加 public key 到 KEYS 文件并提交到 SVN 仓库
```shell
cd /tmp/inlong-dist-dev
mkdir ${release_version}-${rc_version} #创建版本目录
@@ -284,24 +284,22 @@ svn add ${release_version}-${rc_version} # 添加到svn版本
svn status # 检查svn状态
svn commit -m "prepare for ${release_version} ${rc_version}" # 提交至svn远程服务器
```
-### 关闭Apache Staging仓库
-> 请确保所有的artifact都是ok的
-1. **先登录**http://repository.apache.org , 使用Apache账号登录
-2. 点击左侧的Staging repositories，
-3. 搜索InLong关键字，选择你最近上传的仓库
-4. 点击上方的Close按钮，这个过程会进行一系列检查
-5. 检查通过以后, 在下方的Summary标签页上出现一个连接，请保存好这个链接，需要放在接下来的投票邮件当中。
+### 关闭 Apache Staging 仓库
+> 请确保所有的 artifact 都是 ok 的
+1. **先登录** http://repository.apache.org , 使用 Apache 账号登录
+2. 点击左侧的 Staging repositories，
+3. 搜索 InLong 关键字，选择你最近上传的仓库
+4. 点击上方的 Close 按钮，这个过程会进行一系列检查
+5. 检查通过以后, 在下方的 Summary 标签页上出现一个连接，请保存好这个链接，需要放在接下来的投票邮件当中。
链接应该是类似这样的:
`https://repository.apache.org/content/repositories/orgapacheinlong-xxxx`
-WARN: 请注意点击Close可能会出现失败，请检查失败原因并处理
+WARN: 请注意点击 Close 可能会出现失败，请检查失败原因并处理
## 进入投票
-> InLong仍旧在孵化中，需要进行两次投票，
+> InLong 已毕业，只需要进行一次投票。
- InLong社区投票，发邮件至：`[email protected]`
-- incubator社区投票，发邮件至：`[email protected]`
-InLong毕业之后，只需要在InLong社区投票
-### InLong社区投票
+### InLong 社区投票
#### 投票模板
@@ -310,7 +308,7 @@ InLong毕业之后，只需要在InLong社区投票
内容：
-Hello Apache InLong PPMC and Community,
+Hello Apache InLong PMC and Community,
This is a call for a vote to release Apache InLong version
${release_version}-${rc_version}.
@@ -342,21 +340,21 @@ Hello Apache InLong PPMC and Community,
[ ] +0
[ ] -1 Do not release this package because...
- To learn more about apache inlong, please see
+ To learn more about apache InLong, please see
http://inlong.apache.org/
Checklist for reference:
[ ] Download links are valid.
[ ] Checksums and signatures.
- [ ] LICENSE/NOTICE/DISCLAIMER files exist
+ [ ] LICENSE/NOTICE files exist
[ ] No unexpected binary files
[ ] All source files have ASF headers
[ ] Can compile from source
[ ] All Tests Passed
More detailed checklist please refer to:
-
https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist
+ https://inlong.apache.org/community/how-to-verify
Thanks,
Your InLong Release Manager
@@ -368,151 +366,81 @@ Your InLong Release Manager
内容：
-Hello Apache InLong PPMC and Community,
+Hello Apache InLong PMC and Community,
The vote closes now as 72hr have passed. The vote PASSES with
- xx (+1 non-binding) votes from the PPMC,
- xx (+1 binding) vote from the IPMC,
+ xx (+1 non-binding) votes from the PMC,
xx (+1 non-binding) vote from the rest of the developer community,
and no further 0 or -1 votes.
The vote thread: {vote_mail_address}
- I will now bring the vote to [email protected] to get approval
by the IPMC.
- If this vote passes also, the release is accepted and will be published.
+ The release is accepted and will be published.
Thank you for your support.
Your InLong Release Manager
```
-### incubator社区投票
-
-#### 投票模板
-
-```html
-标题：[VOTE] Release Apache InLong(Incubating) ${release_version} ${rc_version}
-
-内容：
-
-Hello Incubator Community,
-
- This is a call for a vote to release Apache InLong(Incubating) version
- ${release_version} ${rc_version}
-
- The Apache InLong community has voted on and approved a proposal to release
- Apache InLong(Incubating) version ${release_version} ${rc_version}
-
- We now kindly request the Incubator PMC members review and vote on this
- incubator release.
-
- InLong community vote thread:
- • [投票链接]
-
- Vote result thread:
- • [投票结果链接]
-
- The release candidate:
- •
https://dist.apache.org/repos/dist/dev/inlong/${release_version}-${rc_version}/
-
- Git tag for the release:
- •
https://github.com/apache/inlong/releases/tag/${release_version}-${rc_version}
-
- Release notes:
- •
https://github.com/apache/inlong/blob/${release_version}-${rc_version}/CHANGES.md
-
- The artifacts signed with PGP key [填写你个人的KEY], corresponding to
[填写你个人的邮箱], that can be found in keys file:
- • https://downloads.apache.org/inlong/KEYS
-
- The vote will be open for at least 72 hours or until necessary number of
votes are reached.
-
- Please vote accordingly:
-
- [ ] +1 approve
- [ ] +0 no opinion
- [ ] -1 disapprove with the reason
-
-Thanks,
-On behalf of Apache InLong(Incubating) community
-
-```
-
-#### 宣布投票结果模板
-```html
-标题：[RESULT][VOTE] Release Apache InLong ${release_version} {rc_version}
-
-内容：
-Hi all
-
-Thanks for reviewing and voting for Apache InLong(Incubating)
${release_version} {rc_version}
-release, I am happy to announce the release voting has passed with [投票结果数]
-binding votes, no +0 or -1 votes. Binding votes are from IPMC
-
- - xxx
- - xxx
- - xxx
-
-The voting thread is:
-[投票链接]
-
-Many thanks for all our mentors helping us with the release procedure, and
-all IPMC helped us to review and vote for Apache InLong(Incubating) release. I
will
-be working on publishing the artifacts soon.
-
-Thanks
-On behalf of Apache InLong(Incubating) community
-```
-
## 正式发布
-### 合并release-${release_version}分支的改动到master分支
-### 将源码和二进制包从svn的dev目录移动到release目录
+### 合并 release-${release_version} 分支的改动到 master 分支
+### 将源码和二进制包从 svn 的 dev 目录移动到 release 目录
```shell
-svn mv
https://dist.apache.org/repos/dist/dev/incubator/inlong/${release_version}-${rc_version}
https://dist.apache.org/repos/dist/release/incubator/inlong/${release_version}
-m "Release ${release_version}"
+svn mv
https://dist.apache.org/repos/dist/dev/inlong/${release_version}-${rc_version}
https://dist.apache.org/repos/dist/release/inlong/${release_version} -m
"Release ${release_version}"
```
-### 确认dev和release下的包是否正确
-1.
确认[dev](https://dist.apache.org/repos/dist/dev/incubator/inlong/)下的`${release_version}-${rc_version}`已被删除
-2.
删除[release](https://dist.apache.org/repos/dist/release/incubator/inlong/)目录下上一个版本的发布包，这些包会被自动保存在[这里](https://archive.apache.org/dist/incubator/inlong/)
+### 确认 dev 和 release 下的包是否正确
+1.
确认[dev](https://dist.apache.org/repos/dist/dev/inlong/)下的`${release_version}-${rc_version}`已被删除
+2.
删除[release](https://dist.apache.org/repos/dist/release/inlong/)目录下上一个版本的发布包，这些包会被自动保存在[这里](https://archive.apache.org/dist/inlong/)
```shell
-svn delete
https://dist.apache.org/repos/dist/release/incubator/inlong/${last_release_version}
-m "Delete ${last_release_version}"
+svn delete
https://dist.apache.org/repos/dist/release/inlong/${last_release_version} -m
"Delete ${last_release_version}"
```
-### 在Apache Staging仓库发布版本
-> 请确保所有的artifact都是ok的
-1. 登录http://repository.apache.org , 使用Apache账号登录
-2. 点击左侧的Staging repositories，
-3. 搜索InLong关键字，选择你最近上传的仓库，投票邮件中指定的仓库
-4. 点击上方的`Release`按钮，这个过程会进行一系列检查
+### 在 Apache Staging 仓库发布版本
+> 请确保所有的 artifact 都是 ok 的
+1. 登录 http://repository.apache.org , 使用 Apache 账号登录
+2. 点击左侧的 Staging repositories，
+3. 搜索 InLong 关键字，选择你最近上传的仓库，投票邮件中指定的仓库
+4. 点击上方的 `Release` 按钮，这个过程会进行一系列检查
**等仓库同步到其他数据源，一般需要24小时**
### 更新官网链接
-### 发邮件到 `[email protected]` 和 `[email protected]`
+### 发ANNOUNCE邮件，主送 `[email protected]`，抄送 `[email protected]`
**请确保6.4中的仓库已发布成功，一般是在6.4后的24小时后发布邮件**
-宣布release邮件模板：
+宣布 release 邮件模板：
```html
-标题： [ANNOUNCE] Release Apache InLong(incubating) ${release_version}
+标题： [ANNOUNCE] Release Apache InLong ${release_version}
内容：
Hi all,
-The Apache InLong(incubating) community is pleased to announce
-that Apache InLong(incubating) ${release_version} has been released!
+The Apache InLong community is pleased to announce
+that Apache InLong ${release_version} has been released!
Apache InLong is a one-stop integration framework for massive data that
provides automatic, secure,
distributed, and efficient data publishing and subscription capabilities.
This platform helps you easily build stream-based data applications.
-Download Links: https://inlong.apache.org/download/main
+This release contains a number of new features, bug fixes and
+improvements compared to the last version released before.
+The notable changes since ${release_version} include:
+1. xxxxx
+2. yyyyyy
+3. zzzzzz
+
-Release Notes: https://inlong.apache.org/download/release-${release_version}
+Please refer to the change log for the complete list of changes:
+https://github.com/apache/inlong/blob/${release_version}-${rc_version}/CHANGES.md
-Website: https://inlong.apache.org/
+Apache InLong website: https://inlong.apache.org/
+
+Download Links: https://inlong.apache.org/download/main
InLong Resources:
-- Issue: https://github.com/apache/incubator-inlong/issues
+- Issue: https://github.com/apache/inlong/issues
- Mailing list: [email protected]
Thanks
-On behalf of Apache InLong(Incubating) community
+On behalf of Apache InLong community
```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-verify.md
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-verify.md
index b1714cc49..b786776af 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-verify.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-verify.md
@@ -3,27 +3,25 @@ title: 如何验证版本
sidebar_position: 7
---
-详细的检查列表请参考: [check
list](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist)
-
## 下载要发布的候选版本到本地环境
```shell
-svn co
https://dist.apache.org/repos/dist/dev/incubator/inlong/${release_version}-${rc_version}/
+svn co
https://dist.apache.org/repos/dist/dev/inlong/${release_version}-${rc_version}/
```
## 验证上传的版本是否合规
> 开始验证环节，验证包含但不局限于以下内容和形式
### 查看发布包是否完整
-> 上传到dist的包必须包含源码包，二进制包可选
+> 上传到 dist 的包必须包含源码包，二进制包可选
1. 是否包含源码包
2. 是否包含源码包的签名
-3. 是否包含源码包的sha512
+3. 是否包含源码包的 sha512
4. 如果上传了二进制包，则同样检查(2)-(4)所列的内容
-### 检查gpg签名
+### 检查 gpg 签名
- 导入公钥
```shell
- curl https://dist.apache.org/repos/dist/dev/incubator/inlong/KEYS > KEYS #
下载KEYS
+ curl https://downloads.apache.org/inlong/KEYS > KEYS # 下载KEYS
gpg --import KEYS # 导入KEYS到本地
```
- 信任公钥
@@ -92,14 +90,14 @@ svn co
https://dist.apache.org/repos/dist/dev/incubator/inlong/${release_version
- 检查结果
> 出现类似以下内容则说明签名正确，关键字：**`Good signature`**
```shell
-apache-inlong-0.3.0-incubating-src.tar.gz
+apache-inlong-1.3.0-src.tar.gz
gpg: Signature made Sat May 30 11:45:01 2020 CST
gpg: using RSA key 9B12C2228BDFF4F4CFE849445EF3A66D57EC647A
gpg: Good signature from "Guangxu Cheng <[email protected]>" [ultimate]gular2
```
-### 检查sha512哈希
-> 本地计算sha512哈希后，验证是否与dist上的一致
+### 检查 sha512 哈希
+> 本地计算 sha512 哈希后，验证是否与 dist 上的一致
```shell
for i in *.tar.gz; do echo $i; gpg --print-md SHA512 $i; done
#或者
@@ -113,11 +111,10 @@ for i in *.tar.gz.sha512; do echo $i; sha512sum -c $i;
done
### 检查源码包的文件内容
- 解压缩`apache-inlong-${release_version}-src.tar.gz`，进行如下检查:
+ 解压缩 `apache-inlong-${release_version}-src.tar.gz`，进行如下检查:
- - DISCLAIMER文件是否存在及内容是否正确
- - LICENSE and NOTICE文件是否存在及内容是否正确
- - 所有文件是否带有ASF License头
+ - LICENSE and NOTICE 文件是否存在及内容是否正确
+ - 所有文件是否带有 ASF License 头
- 源码是否能够正常编译
- 单测是否能够跑通
- ....
@@ -125,14 +122,13 @@ for i in *.tar.gz.sha512; do echo $i; sha512sum -c $i;
done
注意事项：
在实践过程中，发现比较多的困扰问题影响到我们的版本验证，如下处理供参考：
- 校验版本前先清理掉本地仓库；
- - 编译方法不限制，但由于项目里的模块做了docker化处理，首次编译建议先“mvn clean package
install”，其他推荐的操作还有“mvn compile”，“mvn clean package”；
- - 执行单元测试时，大家要用“mvn clean test”单独运行，确保没有隐藏问题。
+ - 编译方法不限制，但由于项目里的模块做了 docker 化处理，首次编译建议先 “mvn clean package
install”，其他推荐的操作还有 “mvn compile”，“mvn clean package”；
+ - 执行单元测试时，大家要用 “mvn clean test” 单独运行，确保没有隐藏问题。
### 检查二进制包
- 解压缩`apache-inlong-client-${release_version}-src.tar.gz`和`
+ 解压缩 `apache-inlong-client-${release_version}-src.tar.gz` 和 `
apache-inlong-server-${release_version}-src.tar.gz`，进行如下检查:
- - DISCLAIMER文件是否存在及内容是否正确
- - LICENSE and NOTICE文件是否存在及内容是否正确
+ - LICENSE and NOTICE 文件是否存在及内容是否正确
- 能否正常部署成功
- 部署测试环境、验证生产消费能否正常运行
- 验证你认为可能会出问题的地方
