You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by du...@apache.org on 2023/04/06 08:24:44 UTC
[shardingsphere] branch master updated: Integrate community suggestion into release guide (#25028)
This is an automated email from the ASF dual-hosted git repository.
duanzhengqiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new b266c657723 Integrate community suggestion into release guide (#25028)
b266c657723 is described below
commit b266c657723fa049e9128201d966f0324b206c87
Author: 吴伟杰 <wu...@apache.org>
AuthorDate: Thu Apr 6 16:24:37 2023 +0800
Integrate community suggestion into release guide (#25028)
---
.../content/involved/release/shardingsphere.cn.md | 43 ++++++++++++--------
.../content/involved/release/shardingsphere.en.md | 47 +++++++++++++---------
2 files changed, 54 insertions(+), 36 deletions(-)
diff --git a/docs/community/content/involved/release/shardingsphere.cn.md b/docs/community/content/involved/release/shardingsphere.cn.md
index dc55ca1b0b4..f4ef0d0b435 100644
--- a/docs/community/content/involved/release/shardingsphere.cn.md
+++ b/docs/community/content/involved/release/shardingsphere.cn.md
@@ -6,6 +6,8 @@ chapter = true
## 准备工作
+准备工作在 **代码冻结前 7 天** 进行，以便于贡献者根据发布计划控制研发进度。
+
### 1. 检查并更新 LICENSE 和 NOTICE
检查并更新 LICENSE 文件中的依赖版本号。
@@ -21,7 +23,13 @@ Release Note 需提供中文/英文两种版本，确认中英文描述是否明
1. 功能增强
1. 漏洞修复
-### 3. 确认 Issue 列表
+### 3. 新建下一版本 Milestone
+
+1. 新建 [Github Milestone](https://github.com/apache/shardingsphere/milestones)；
+1. 指定下一版本号；
+1. **设置截至日期为下一版本代码冻结日期** 。
+
+### 4. 确认 Issue 列表
打开 [Github Issues](https://github.com/apache/shardingsphere/issues)，过滤 Milestone 为 `${RELEASE.VERSION}` 且状态为打开的 Issue:
@@ -29,7 +37,7 @@ Release Note 需提供中文/英文两种版本，确认中英文描述是否明
1. 未完成的 Issue 与负责人进行沟通，如果不影响本次发版，修改 Milestone 为下一个版本；
1. 确认发布版本的 Milestone 下没有打开状态的 Issue。
-### 4. 确认 Pull Request 列表
+### 5. 确认 Pull Request 列表
打开 [Github Pull requests](https://github.com/apache/shardingsphere/pulls)，过滤 Milestone 为 `${RELEASE.VERSION}` 且状态为打开的 Pull Request:
@@ -37,18 +45,11 @@ Release Note 需提供中文/英文两种版本，确认中英文描述是否明
1. 无法 Merge 且不影响本次发版的 Pull Request，修改 Milestone 为下一个版本；
1. 确认发布版本的 Milestone 下没有打开状态的 Pull Request。
-### 5. 发送讨论邮件
-
-1. 创建 [GitHub Discussion](https://github.com/apache/shardingsphere/discussions) 并在讨论内容中列出 Release Note；
-1. 发送邮件至 [dev@shardingsphere.apache.org](mailto:dev@shardingsphere.apache.org)，在邮件正文中链接 GitHub Discussion；
-1. 关注邮件列表，确认社区开发者对 Release Note 没有任何疑问。
+### 6. 发起发布讨论
-### 6. 关闭 Milestone
-
-打开 [Github Milestone](https://github.com/apache/shardingsphere/milestones)
-
-1. 确认 `${RELEASE.VERSION}` 的 Milestone 完成状态为 100%；
-1. 点击 `Close` 关闭 Milestone。
+1. 创建 [GitHub Discussion](https://github.com/apache/shardingsphere/discussions) 并在讨论内容中列出 Release Note，并 **明确具体代码冻结日期** ；
+1. 发送邮件至 [dev@shardingsphere.apache.org](mailto:dev@shardingsphere.apache.org)，在邮件正文中链接 GitHub Discussion，并 **明确具体代码冻结日期** ；
+1. 关注 Discussion 与邮件列表，确认社区开发者对 Release Note 没有任何疑问。
## GPG 设置
@@ -149,12 +150,20 @@ gpg --keyserver hkp://keyserver.ubuntu.com --send-key 700E6065
## 准备发布分支
-### 1. 创建发布分支
+### 1. 关闭发布版本 Milestone
+
+打开 [Github Milestone](https://github.com/apache/shardingsphere/milestones)
+
+1. 确认 `${RELEASE.VERSION}` 的 Milestone 完成状态为 100%；
+1. 点击 `Close` 关闭 Milestone。
+
+### 2. 确认发布 commit 并创建发布分支
假设从 GitHub 下载的 ShardingSphere 源代码在 `~/open_source/shardingsphere/`，从本地重新克隆一份到 `~/shardingsphere/` 目录。
假设即将发布的版本为 `${RELEASE.VERSION}`，创建 `${RELEASE.VERSION}-release` 分支，接下来的操作都在该分支进行。
+参考命令：
```shell
cd ~
git clone ~/open_source/shardingsphere
@@ -167,7 +176,7 @@ git checkout -b ${RELEASE.VERSION}-release
git push origin ${RELEASE.VERSION}-release
```
-### 2. 更新版本说明和示例版本
+### 3. 更新版本说明和示例版本
在发布分支上更新如下文件，并提交 PR 到发布分支：
@@ -177,7 +186,7 @@ https://github.com/apache/shardingsphere/blob/${RELEASE.VERSION}-release/RELEASE
更新 `examples` 模块的 pom，将版本由 `${DEVELOPMENT.VERSION}` 替换为 `${RELEASE.VERSION}`，并提交 PR 到发布分支。
-### 3. 更新下载页面
+### 4. 更新下载页面
更新如下页面：
* <https://shardingsphere.apache.org/document/current/en/downloads/>
@@ -185,7 +194,7 @@ https://github.com/apache/shardingsphere/blob/${RELEASE.VERSION}-release/RELEASE
GPG 签名文件和哈希校验文件的下载连接应该使用这个前缀：`https://downloads.apache.org/shardingsphere/`。
-### 4. 修改 README 文件
+### 5. 修改 README 文件
更新 `README.md` 和 `README_ZH.md` 里的 `${RELEASE.VERSION}` 和 `${NEXT.RELEASE.VERSION}`。
diff --git a/docs/community/content/involved/release/shardingsphere.en.md b/docs/community/content/involved/release/shardingsphere.en.md
index 1c32c1f4c56..3c578b44fc7 100644
--- a/docs/community/content/involved/release/shardingsphere.en.md
+++ b/docs/community/content/involved/release/shardingsphere.en.md
@@ -4,15 +4,17 @@ weight = 1
chapter = true
+++
-## Prepare before release
+## Prepare Before Release
-### 1. Check and update LICENSE and NOTICE
+The preparation work is carried out **7 days before cutting release**, so that contributors can control the development progress according to the release plan.
+
+### 1. Check and Update LICENSE and NOTICE
Check and update dependency version in LICENSE.
Check and update year in NOTICE.
-### 2. Confirm release notes
+### 2. Confirm Release Notes
The release note should be provided in English / Chinese, confirm whether English and Chinese description are clear,
and shall be classified according to the following labels:
@@ -22,7 +24,13 @@ and shall be classified according to the following labels:
1. Enhancement
1. Bug Fix
-### 3. Confirm issue list
+### 3. Create Milestone for Next Development
+
+1. Create a [Github Milestone](https://github.com/apache/shardingsphere/milestones);
+1. Set milestone title to next development version;
+1. **Set the `due date` as the next version release cutting date** 。
+
+### 4. Confirm Issue List
Open [GitHub issues](https://github.com/apache/shardingsphere/issues), filter the issue whose milestone is `${RELEASE.VERSION}` and status is open:
@@ -30,7 +38,7 @@ Open [GitHub issues](https://github.com/apache/shardingsphere/issues), filter th
1. For outstanding issues, communicate with the developer in charge. If this release is not affected, modify milestone to the next version;
1. Confirm that there is no issue in open status under milestone of release version.
-### 4. Confirm pull request list
+### 5. Confirm Pull Request List
Open [GitHub pull requests](https://github.com/apache/shardingsphere/pulls), filter pull requests whose milestone is `${RELEASE.VERSION}` and status is open:
@@ -38,19 +46,12 @@ Open [GitHub pull requests](https://github.com/apache/shardingsphere/pulls), fil
1. For pull requests that cannot merge and do not affect this release, modify milestone to the next version;
1. Confirm that there is no open pull request under milestone of release version.
-### 5. Call for a discussion
+### 6. Call for a Discussion
-1. Create a [GitHub Discussion](https://github.com/apache/shardingsphere/discussions) contains all the release notes;
-1. Send email to [dev@shardingsphere.apache.org](mailto:dev@shardingsphere.apache.org) with the GitHub Discussion in the message body;
+1. Create a [GitHub Discussion](https://github.com/apache/shardingsphere/discussions) contains all the release notes and **release cutting date** ;
+1. Send email to [dev@shardingsphere.apache.org](mailto:dev@shardingsphere.apache.org) with the GitHub Discussion and **release cutting date** in the message body;
1. Follow the mailing list and confirm that the community developers have no questions about the release note.
-### 6. Close milestone
-
-Open [GitHub milestone](https://github.com/apache/shardingsphere/milestones)
-
-1. Confirm that the milestone completion status of `${RELEASE.VERSION}` is 100%;
-1. Click `close` to close milestone.
-
## GPG Settings
### 1. Install GPG
@@ -151,12 +152,20 @@ Each server will automatically synchronize with one another, so it would be okay
## Prepare Branch for Release
-### 1. Create Release Branch
+### 1. Close milestone
+
+Open [GitHub milestone](https://github.com/apache/shardingsphere/milestones)
+
+1. Confirm that the milestone completion status of `${RELEASE.VERSION}` is 100%;
+1. Click `close` to close milestone.
+
+### 2. Confirm the Release Commit and Create Release Branch
Suppose ShardingSphere source codes downloaded from GitHub is under `~/open_source/shardingsphere/`, clone a new one into `~/shardingsphere/` directory from local.
Suppose the version to be released is `${RELEASE.VERSION}`, create `${RELEASE.VERSION}-release` branch, where all the following operations will be performed.
+Reference command:
```shell
cd ~
git clone ~/open_source/shardingsphere
@@ -169,7 +178,7 @@ git checkout -b ${RELEASE.VERSION}-release
git push origin ${RELEASE.VERSION}-release
```
-### 2. Update Release Notes And Example Version
+### 3. Update Release Notes And Example Version
Update the following file in release branch, and submit a PR to release branch:
@@ -179,7 +188,7 @@ https://github.com/apache/shardingsphere/blob/${RELEASE.VERSION}-release/RELEASE
Update the POM of the module `examples`, changing the version from ${DEVELOPMENT.VERSION} to ${RELEASE.VERSION}, and submit a PR to release branch.
-### 3. Update the download page
+### 4. Update the download page
Update the following pages:
* <https://shardingsphere.apache.org/document/current/en/downloads/>
@@ -187,7 +196,7 @@ Update the following pages:
GPG signatures and hashes (SHA* etc) should be prefixed with `https://downloads.apache.org/shardingsphere/`
-### 4. Update README files
+### 5. Update README files
Update `${RELEASE.VERSION}` and `${NEXT.RELEASE.VERSION}` in README.md and README_ZH.md.