Skip to content

Ant Design Pro 发布流程

ddcat1115 edited this page Jan 10, 2018 · 8 revisions

首先需要知道,我们一共有 3 个项目需要发布。

切记,三者一定是一起发布,因为互相有强依赖关系

发布顺序如下:组件、脚手架、站点。

发布流程

1. 更新最新代码

更新 ant-design-pro-site 的代码以及 ant-design-pro submodule 的代码

$ git pull --rebase origin master
$ git submodule update

如果有必要(比如 submodule 拉取报错),可以单独切换到 scaffold 目录中单独拉去 ant-design-pro 代码。

2. 编辑 docs/changelog.md(站点、脚手架、组件的变更都在这里)

  • docs/changelog.md 添加发布日志,可以用 compare 功能找到当前和之前版本的区别(站点变动同上),将有价值的改动如实反馈给用户
    • 将脚手架变更与组件变更需要分开。
    • 对用户使用上无感知的改动建议(文档修补、微小的样式优化、代码风格重构等等)不要提及,保持 changelog 的内容有效性。
    • 用面向开发者的角度和叙述方式撰写,不描述修复细节,描述问题和对开发者的影响。
    • 新增属性时,建议用易于理解的语言描述用户可以感知的变化。(例如,新增 onCellClick 属性,可以定义单元格点击事件)
    • 尽量给出原始的 issue 或 PR 链接,社区提交的 PR 改动加上提交者的链接。
    • 底层模块升级中间版本要给出变动说明。
    • 可以学习下 blueprint 的 changelog 写法,添加必要的截图帮助说清楚新功能, emoji 让文档更生动。
    • 在 package.json(scaffold 中的版本) 里修改 version 为此次发布的版本号,按照语义化版本进行升级,bugfix 升级小版本(patch),新功能添加升级中间的版本号(minor)。

3. 跑通 lint(分别是 site 和 scaffold)

发布前确保 node_modules 目录是最新的,并且本地和线上 travis 的 tnpm run lint 都是通过的。

4. 先发组件

项目 site 根目录运行:

npm run components-publish

此命令会自动同步 scaffold/package.jsonversiondependences/config/components/package.json 中,保证脚手架与组件包版本和依赖一致

5. 然后记得打 tag

在 scaffold 目录下:

git tag [version]
git push origin [version]

6. 再发脚手架

在 scaffold 目录运行:

npm run site

7. 最后发 site 站点

项目 site 根目录运行

npm run site

Github Tag

进入 Pro 的 Github release。如果之前已发布了相关 tag,则进入这个 tag 点击编辑。 标题填写发布的版本号,填写 CHANGELOG 的内容。最后点击左下角绿色的 Publish release 按钮发布。