From 81c6211c52bcceef45774e2c715cb97716e38faa Mon Sep 17 00:00:00 2001 From: Yu Yang Date: Wed, 19 Apr 2017 11:10:59 +0800 Subject: [PATCH] Releasing Paddle Standard. --- .../01.how_to_release_paddle.md | 22 +++++++++++++++++++ .../02.paddle_branching_model.md | 16 ++++++++++++++ .../03.regression_test_list.md | 18 +++++++++++++++ 3 files changed, 56 insertions(+) create mode 100644 doc/design/releasing_process/01.how_to_release_paddle.md create mode 100644 doc/design/releasing_process/02.paddle_branching_model.md create mode 100644 doc/design/releasing_process/03.regression_test_list.md diff --git a/doc/design/releasing_process/01.how_to_release_paddle.md b/doc/design/releasing_process/01.how_to_release_paddle.md new file mode 100644 index 00000000000..bf11f94c9df --- /dev/null +++ b/doc/design/releasing_process/01.how_to_release_paddle.md @@ -0,0 +1,22 @@ +# Paddle发行规范 + +Paddle使用[git-flow](./02.paddle_branching_model.md) branching model做分支管理，使用[Semantic Versioning](http://semver.org/)标准表示Paddle版本号。 + +Paddle每次发新的版本，遵循以下流程: + +1. 从`develop`分支派生出新的分支，分支名为`版本号rc`。例如，`0.10.0rc` +2. 将新分支的版本打上tag，tag为`版本号rc.Patch号`。第一个tag为`0.10.0rc0`，第二个为`0.10.0rc1`，依次类推。 +3. 对这个版本的提交，做如下几个操作: + * 编译这个版本的Docker发行镜像，发布到dockerhub。如果失败，Patch号加一，返回第二步 + * 编译这个版本的Ubuntu Deb包。如果失败，Patch号加一，返回第二步。 + * 使用[Regression Test List](./03.regression_test_list.md)作为检查列表，测试Docker镜像/ubuntu安装包的功能正确性 + * 如果失败，记录下所有失败的例子，在这个`rc`分支中，修复所有bug后，Patch号加一，返回第二步 +4. 第三步完成后，将`rc`分支合入master分支，并删除`rc`分支。将master分支的合入commit打上tag，tag为`版本号`。同时再将`master`分支合入`develop`分支。最后删除`rc`分支。 +5. 编译master分支的Docker发行镜像，发布到dockerhub。编译ubuntu的deb包，发布到github release页面 +6. 协同完成Release Note的书写 + + +需要注意的是: + +* `rc`分支一旦建立，一般不允许再从`develop`分支合入`rc`。这样保证`rc`分支功能的封闭，方便测试人员测试Paddle的行为。 +* 在`rc`分支存在的时候，如果有bugfix的行为，需要将bugfix的分支同时merge到`master`, `develop`和`rc`这三个分支。 diff --git a/doc/design/releasing_process/02.paddle_branching_model.md b/doc/design/releasing_process/02.paddle_branching_model.md new file mode 100644 index 00000000000..562f0a07576 --- /dev/null +++ b/doc/design/releasing_process/02.paddle_branching_model.md @@ -0,0 +1,16 @@ +# Paddle 分支规范 + +Paddle开发过程使用[git-flow](http://nvie.com/posts/a-successful-git-branching-model/)分支规范，并适应github的特性做了一些区别。 + +* Paddle的主版本库遵循[git-flow](http://nvie.com/posts/a-successful-git-branching-model/)分支规范。其中: + * `master`分支为稳定(stable branch)版本分支。每一个`master`分支的版本都是经过单元测试和回归测试的版本。 + * `develop`分支为开发(develop branch)版本分支。每一个`develop`分支的版本都经过单元测试，但并没有经过回归测试。 + * `rc`分支为每一次Release时建立的临时分支。在这个阶段的代码正在经历回归测试。 + +* 其他用户的fork版本库并不需要严格遵守[git-flow](http://nvie.com/posts/a-successful-git-branching-model/)分支规范，但所有fork的版本库的所有分支都相当于特性分支。 + * 建议，开发者fork的版本库使用`develop`分支同步主版本库的`develop`分支 + * 建议，开发者fork的版本库中，再基于`develop`版本fork出自己的功能分支。 + * 当功能分支开发完毕后，向Paddle的主版本库提交`Pull Reuqest`，进而进行代码评审。 + * 在评审过程中，开发者修改自己的代码，可以继续在自己的功能分支提交代码。 + +* BugFix分支也是在开发者自己的fork版本库维护，与功能分支不同的是，BugFix分支需要分别给主版本库的`master`、`develop`与可能有的`rc`分支，同时提起`Pull Request`。 diff --git a/doc/design/releasing_process/03.regression_test_list.md b/doc/design/releasing_process/03.regression_test_list.md new file mode 100644 index 00000000000..dbd091deeef --- /dev/null +++ b/doc/design/releasing_process/03.regression_test_list.md @@ -0,0 +1,18 @@ +# Paddle回归测试列表 + +本列表说明Paddle发版之前需要测试的功能点。 + +## Paddle Book中所有章节 + +Paddle每次发版本首先要保证Paddle Book中所有章节功能的正确性。功能的正确性包括验证Paddle目前的`paddle_trainer`训练和纯使用`Python`训练模型正确性。 + +| | 新手入门章节 | 识别数字 | 图像分类 | 词向量 | 情感分析 | 语意角色标注 | 机器翻译 | 个性化推荐 | +| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | +| API.V2 + Docker + GPU | +| API.V2 + Docker + CPU | +| `paddle_trainer` + Docker + GPU | +| `paddle_trainer` + Docker + CPU | +| API.V2 + Ubuntu + GPU | +| API.V2 + Ubuntu + CPU | +| `paddle_trainer` + Ubuntu + GPU | +| `paddle_trainer` + Ubuntu + CPU | -- GitLab