Skip to content

Commit 2f633a6

Browse files
committed
Merge 3 files into releasing_process.md
1 parent 8af90f5 commit 2f633a6

File tree

4 files changed

+58
-56
lines changed

4 files changed

+58
-56
lines changed

doc/design/releasing_process.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Paddle发行规范
2+
3+
Paddle使用git-flow branching model做分支管理,使用[Semantic Versioning](http://semver.org/)标准表示Paddle版本号。
4+
5+
Paddle每次发新的版本,遵循以下流程:
6+
7+
1.`develop`分支派生出新的分支,分支名为`release/版本号`。例如,`release/0.10.0`
8+
2. 将新分支的版本打上tag,tag为`版本号rc.Patch号`。第一个tag为`0.10.0rc1`,第二个为`0.10.0rc2`,依次类推。
9+
3. 对这个版本的提交,做如下几个操作:
10+
* 编译这个版本的Docker发行镜像,发布到dockerhub。如果失败,修复Docker编译镜像问题,Patch号加一,返回第二步
11+
* 编译这个版本的Ubuntu Deb包。如果失败,修复Ubuntu Deb包编译问题,Patch号加一,返回第二步。
12+
* 使用Regression Test List作为检查列表,测试Docker镜像/ubuntu安装包的功能正确性
13+
* 如果失败,记录下所有失败的例子,在这个`release/版本号`分支中,修复所有bug后,Patch号加一,返回第二步
14+
4. 第三步完成后,将`release/版本号`分支合入master分支,并删除`release/版本号`分支。将master分支的合入commit打上tag,tag为`版本号`。同时再将`master`分支合入`develop`分支。最后删除`release/版本号`分支。
15+
5. 编译master分支的Docker发行镜像,发布到dockerhub。编译ubuntu的deb包,发布到github release页面
16+
6. 协同完成Release Note的书写
17+
18+
19+
需要注意的是:
20+
21+
* `release/版本号`分支一旦建立,一般不允许再从`develop`分支合入`release/版本号`。这样保证`release/版本号`分支功能的封闭,方便测试人员测试Paddle的行为。
22+
*`release/版本号`分支存在的时候,如果有bugfix的行为,需要将bugfix的分支同时merge到`master`, `develop``release/版本号`这三个分支。
23+
24+
# Paddle 分支规范
25+
26+
Paddle开发过程使用[git-flow](http://nvie.com/posts/a-successful-git-branching-model/)分支规范,并适应github的特性做了一些区别。
27+
28+
* Paddle的主版本库遵循[git-flow](http://nvie.com/posts/a-successful-git-branching-model/)分支规范。其中:
29+
* `master`分支为稳定(stable branch)版本分支。每一个`master`分支的版本都是经过单元测试和回归测试的版本。
30+
* `develop`分支为开发(develop branch)版本分支。每一个`develop`分支的版本都经过单元测试,但并没有经过回归测试。
31+
* `release/版本号`分支为每一次Release时建立的临时分支。在这个阶段的代码正在经历回归测试。
32+
33+
* 其他用户的fork版本库并不需要严格遵守[git-flow](http://nvie.com/posts/a-successful-git-branching-model/)分支规范,但所有fork的版本库的所有分支都相当于特性分支。
34+
* 建议,开发者fork的版本库使用`develop`分支同步主版本库的`develop`分支
35+
* 建议,开发者fork的版本库中,再基于`develop`版本fork出自己的功能分支。
36+
* 当功能分支开发完毕后,向Paddle的主版本库提交`Pull Reuqest`,进而进行代码评审。
37+
* 在评审过程中,开发者修改自己的代码,可以继续在自己的功能分支提交代码。
38+
39+
* BugFix分支也是在开发者自己的fork版本库维护,与功能分支不同的是,BugFix分支需要分别给主版本库的`master``develop`与可能有的`release/版本号`分支,同时提起`Pull Request`
40+
41+
# Paddle回归测试列表
42+
43+
本列表说明Paddle发版之前需要测试的功能点。
44+
45+
## Paddle Book中所有章节
46+
47+
Paddle每次发版本首先要保证Paddle Book中所有章节功能的正确性。功能的正确性包括验证Paddle目前的`paddle_trainer`训练和纯使用`Python`训练模型正确性。
48+
49+
| | 新手入门章节 | 识别数字 | 图像分类 | 词向量 | 情感分析 | 语意角色标注 | 机器翻译 | 个性化推荐 |
50+
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
51+
| API.V2 + Docker + GPU | | | | | | | | |
52+
| API.V2 + Docker + CPU | | | | | | | | |
53+
| `paddle_trainer` + Docker + GPU | | | | | | | | |
54+
| `paddle_trainer` + Docker + CPU | | | | | | | | |
55+
| API.V2 + Ubuntu + GPU | | | | | | | | |
56+
| API.V2 + Ubuntu + CPU | | | | | | | | |
57+
| `paddle_trainer` + Ubuntu + GPU | | | | | | | | |
58+
| `paddle_trainer` + Ubuntu + CPU | | | | | | | | |

doc/design/releasing_process/01.how_to_release_paddle.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

doc/design/releasing_process/02.paddle_branching_model.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

doc/design/releasing_process/03.regression_test_list.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)