From 783174f40fdfccdb8511ddd27b53ea13ea86ab6c Mon Sep 17 00:00:00 2001 From: Yu Date: Mon, 27 Jun 2022 17:27:56 +0800 Subject: [PATCH 1/4] docs: add release flow docs --- .../venus-market-design-roadmap.md} | 0 documentation/misc/release-issue-template.md | 63 +++++++++++++++++++ documentation/{cn => zh}/refactor_notes.md | 0 3 files changed, 63 insertions(+) rename documentation/{venus-market module design & roadmap.md => en/venus-market-design-roadmap.md} (100%) create mode 100644 documentation/misc/release-issue-template.md rename documentation/{cn => zh}/refactor_notes.md (100%) diff --git a/documentation/venus-market module design & roadmap.md b/documentation/en/venus-market-design-roadmap.md similarity index 100% rename from documentation/venus-market module design & roadmap.md rename to documentation/en/venus-market-design-roadmap.md diff --git a/documentation/misc/release-issue-template.md b/documentation/misc/release-issue-template.md new file mode 100644 index 0000000000..389334b9f5 --- /dev/null +++ b/documentation/misc/release-issue-template.md @@ -0,0 +1,63 @@ +# Venus X.Y.Z Release + +## 🚢 预计发布时间 + + + +## ✅ 检查项 + +准备: + + - [ ] 从上个稳定版本中`fork`出`release/vX.Y.Z`分支；按[分支管理规范](https://github.com/ipfs-force-community/dev-guidances/blob/master/%E8%B4%A8%E9%87%8F%E7%AE%A1%E7%90%86/%E4%BB%A3%E7%A0%81/git%E4%BD%BF%E7%94%A8/%E5%88%86%E6%94%AF%E7%AE%A1%E7%90%86%E8%A7%84%E8%8C%83.md)进行分支开发 + - [ ] 把`master`中需要的功能特性PR合并至`release/vX.Y.Z`分支 + +准备RC版本: (可选) + +- [ ] `tag`一个`commit`为`vX.Y.Z-rc[x]` +- [ ] 标记为`pre-release` + +测试: + +- [ ] **阶段 0 - 自动化测试** + - 自动化测试 + - [ ] CI: 通过所有CI + +- [ ] **阶段 1 - 自测** + - 升级测试环境 (192.168.1.125) + - [ ] 检查节点同步情况 + - 升级预生产环境 + - [ ] 检查节点同步情况 + - `Metrics`报告 + - Block validation time + - Memory / CPU usage + - Number of goroutines + - IPLD block read latency + - Bandwidth usage + - [ ] 如果有一项比原来有很大的差距，调查并修复 + - 确认以下工作流 ( Butterfly / Calibnet / Mainnet ) + - [ ] 封装一个扇区 + - [ ] 发一个存储订单 + - [ ] 提交一个PoSt + - [ ] (optional) let a sector go faulty, and see it be recovered + +- [ ] **阶段 2 - 社区测试** + - [ ] 社区[Venus Master](https://filecoinproject.slack.com/archives/C03B30M20N7)测试 + - [ ] 新功能特性，配置变化等等的文档撰写 + +- [ ] **阶段 3 - 社区生产测试** + - [ ] 更新[CHANGELOG.md](https://github.com/filecoin-project/venus/blob/master/CHANGELOG.md) + - [ ] 邀请更多社区成员参与测试 + +- [ ] **阶段 4 - 发版** + - [ ] 最终准备 + - [ ] 确认`version.go`已更新 + - [ ] 准备changelog + - [ ] 把`release-vX.Y.Z`并回`releases` + - [ ] tag this merge commit (on the `releases` branch) with `vX.Y.Z` + - [ ] Cut the release [here](https://github.com/filecoin-project/venus/releases/new?prerelease=true&target=releases). + - [ ] 创建新版本的discussion讨论帖 + + +- [ ] **发版后** + - [ ] Update [release-issue-templat.md](https://github.com/filecoin-project/venus/blob/master/documentation/misc/release-issue-template.md) with any improvements determined from this latest release iteration. + - [ ] Create an issue using [release-issue-templat.md](https://github.com/filecoin-project/venus/blob/master/documentation/misc/release-issue-templat.md) for the next release. diff --git a/documentation/cn/refactor_notes.md b/documentation/zh/refactor_notes.md similarity index 100% rename from documentation/cn/refactor_notes.md rename to documentation/zh/refactor_notes.md From 134552c1fb1f9b5cc2d90d787cbf561ad4ec9eec Mon Sep 17 00:00:00 2001 From: Yu Date: Tue, 28 Jun 2022 15:34:11 +0800 Subject: [PATCH 2/4] docs: review change release flow template --- documentation/misc/release-issue-template.md | 33 +++++++++++--------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/documentation/misc/release-issue-template.md b/documentation/misc/release-issue-template.md index 389334b9f5..0e4f07a551 100644 --- a/documentation/misc/release-issue-template.md +++ b/documentation/misc/release-issue-template.md @@ -2,18 +2,22 @@ ## 🚢 预计发布时间 - + -## ✅ 检查项 +## 🤔 版本注意事项 + + + +## ✅ 常规检查项 准备: - [ ] 从上个稳定版本中`fork`出`release/vX.Y.Z`分支；按[分支管理规范](https://github.com/ipfs-force-community/dev-guidances/blob/master/%E8%B4%A8%E9%87%8F%E7%AE%A1%E7%90%86/%E4%BB%A3%E7%A0%81/git%E4%BD%BF%E7%94%A8/%E5%88%86%E6%94%AF%E7%AE%A1%E7%90%86%E8%A7%84%E8%8C%83.md)进行分支开发 - - [ ] 把`master`中需要的功能特性PR合并至`release/vX.Y.Z`分支 + - [ ] 把`master`中需要的功能特性`PR`合并至`release/vX.Y.Z`分支 准备RC版本: (可选) -- [ ] `tag`一个`commit`为`vX.Y.Z-rc[x]` +- [ ] `tag`为`vX.Y.Z-rc[x]` - [ ] 标记为`pre-release` 测试: @@ -23,23 +27,24 @@ - [ ] CI: 通过所有CI - [ ] **阶段 1 - 自测** - - 升级测试环境 (192.168.1.125) + - 升级dev测试环境 - [ ] 检查节点同步情况 - 升级预生产环境 - [ ] 检查节点同步情况 - - `Metrics`报告 + - `Metrics`报告（待开发） - Block validation time - Memory / CPU usage - Number of goroutines - IPLD block read latency - Bandwidth usage - [ ] 如果有一项比原来有很大的差距，调查并修复 - - 确认以下工作流 ( Butterfly / Calibnet / Mainnet ) + - 确认以下工作流 (Z版本可选；X、Y版本必选) - [ ] 封装一个扇区 - [ ] 发一个存储订单 - [ ] 提交一个PoSt - - [ ] (optional) let a sector go faulty, and see it be recovered - + - [ ] 出块验证，出一个块 + - [ ] Snapdeal验证 + - [ ] 让一个扇区变成faulty，观察是否恢复 - [ ] **阶段 2 - 社区测试** - [ ] 社区[Venus Master](https://filecoinproject.slack.com/archives/C03B30M20N7)测试 - [ ] 新功能特性，配置变化等等的文档撰写 @@ -52,12 +57,10 @@ - [ ] 最终准备 - [ ] 确认`version.go`已更新 - [ ] 准备changelog - - [ ] 把`release-vX.Y.Z`并回`releases` - - [ ] tag this merge commit (on the `releases` branch) with `vX.Y.Z` - - [ ] Cut the release [here](https://github.com/filecoin-project/venus/releases/new?prerelease=true&target=releases). - - [ ] 创建新版本的discussion讨论帖 + - [ ] `tag`为`vX.Y.Z` + - [ ] 创建新版本的discussion讨论帖 - [ ] **发版后** - - [ ] Update [release-issue-templat.md](https://github.com/filecoin-project/venus/blob/master/documentation/misc/release-issue-template.md) with any improvements determined from this latest release iteration. - - [ ] Create an issue using [release-issue-templat.md](https://github.com/filecoin-project/venus/blob/master/documentation/misc/release-issue-templat.md) for the next release. + - [ ] 按需更新[release-issue-templat.md](https://github.com/filecoin-project/venus/blob/master/documentation/misc/release-issue-template.md)模版 + - [ ] 使用[release-issue-templat.md](https://github.com/filecoin-project/venus/blob/master/documentation/misc/release-issue-templat.md)模版创建下一个发版issue From 24560d9a0bb2471b2884cbe74807f475fc09a530 Mon Sep 17 00:00:00 2001 From: Yu Date: Tue, 28 Jun 2022 15:36:40 +0800 Subject: [PATCH 3/4] docs: more optimizations --- documentation/misc/release-issue-template.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/documentation/misc/release-issue-template.md b/documentation/misc/release-issue-template.md index 0e4f07a551..6a4e421348 100644 --- a/documentation/misc/release-issue-template.md +++ b/documentation/misc/release-issue-template.md @@ -45,15 +45,11 @@ - [ ] 出块验证，出一个块 - [ ] Snapdeal验证 - [ ] 让一个扇区变成faulty，观察是否恢复 -- [ ] **阶段 2 - 社区测试** +- [ ] **阶段 2 - 社区Beta测试** - [ ] 社区[Venus Master](https://filecoinproject.slack.com/archives/C03B30M20N7)测试 - [ ] 新功能特性，配置变化等等的文档撰写 - -- [ ] **阶段 3 - 社区生产测试** - - [ ] 更新[CHANGELOG.md](https://github.com/filecoin-project/venus/blob/master/CHANGELOG.md) - - [ ] 邀请更多社区成员参与测试 -- [ ] **阶段 4 - 发版** +- [ ] **阶段 3 - 发版** - [ ] 最终准备 - [ ] 确认`version.go`已更新 - [ ] 准备changelog From b454ed7c8fa0cbdd4aeb92d56f92d241636b4c83 Mon Sep 17 00:00:00 2001 From: Yu Date: Wed, 29 Jun 2022 09:59:15 +0800 Subject: [PATCH 4/4] fix: review change --- documentation/misc/release-issue-template.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/documentation/misc/release-issue-template.md b/documentation/misc/release-issue-template.md index 6a4e421348..176faac224 100644 --- a/documentation/misc/release-issue-template.md +++ b/documentation/misc/release-issue-template.md @@ -8,6 +8,8 @@ + + ## ✅ 常规检查项 准备: @@ -31,13 +33,6 @@ - [ ] 检查节点同步情况 - 升级预生产环境 - [ ] 检查节点同步情况 - - `Metrics`报告（待开发） - - Block validation time - - Memory / CPU usage - - Number of goroutines - - IPLD block read latency - - Bandwidth usage - - [ ] 如果有一项比原来有很大的差距，调查并修复 - 确认以下工作流 (Z版本可选；X、Y版本必选) - [ ] 封装一个扇区 - [ ] 发一个存储订单 @@ -54,6 +49,7 @@ - [ ] 确认`version.go`已更新 - [ ] 准备changelog - [ ] `tag`为`vX.Y.Z` + - [ ] 版本发布至`releases`（注：[github](https://github.com/filecoin-project/venus/releases)有区分`tag`和`releases`） - [ ] 创建新版本的discussion讨论帖