Skip to content

新版本发布流程

Kagol edited this page Dec 12, 2021 · 6 revisions

版本发布流程概览

  1. 确定版本号
  2. 代码检视&合入
  3. 部署测试网站(自动化,Gitee Go)
  4. 测试没问题再部署现网
  5. 发布npm(自动化,Gitee Go)
  6. 打tag
  7. 编写Release Notes
  8. 发布掘金文章(可选)

1 确定版本号

版本格式:主版本号.次版本号.修订号,版本号递增规则如下:

  1. 主版本号:当你做了不兼容的 API 修改,
  2. 次版本号:当你做了向下兼容的功能性新增,
  3. 修订号:当你做了向下兼容的问题修正。

先行版本号及版本编译信息可以加到“主版本号.次版本号.修订号”的后面,作为延伸。

参考:

语义化版本控制规范(SemVer)

2 代码检视&合入

基本步骤:

  1. 初步看下修改范围,是否的单独的组件下的文件(未修改公共文件或其他组件),保持PR的单一职责和细粒度。
  2. 识别基本的编码格式、命名错误、文案错误
  3. 识别代码逻辑错误和风险
  4. 没问题就点击审查通过,有问题则给出检视意见,对于不清楚的地方,也可在评论询问PR作者,把检视代码当成与其他开发者交流的机会,发现写的好的地方可以学习,并给PR作者鼓励;发现不好的地方,友好地指出,共同成长和进步;有疑问的地方积极与PR作者探讨。
  5. clone该PR代码,本地跑一遍,看下是否有明显的缺陷
  6. 没问题就点击测试通过
  7. 点击合并分支-接受Pull Request
  8. 完成PR的合并

3 部署测试网站

yarn build
# 构建产物在packages/devui-vue/docs/.vitepress/dist目录

目前部署在: https://kagol.gitee.io/

用Gitee Pages部署在以下仓库: https://gitee.com/kagol/kagol

基本测试步骤:

  1. 验证是否能正常访问
  2. 验证首页是够正常
  3. 验证组件demo/api是否正常
  4. 验证切换主题是否正常
  5. 验证国际化是否正常

4 部署现网

目前部署在: https://devui.gitee.io/

用Gitee Pages部署在以下仓库: https://gitee.com/devui/devui

5 发布npm

npm build:lib
# 构建产物在packages/devui-vue/build中,需要手动修改版本号(后续可考虑自动化)

npm publish

6 打tag

tag入口:

https://gitee.com/devui/vue-devui/tags

tag名称格式:v1.0.0-beta.8 tag描述一般是该版本涉及的比较大的修改,比如增加新组件、给组件增加新特性等

7 编写Release Notes

分成以下部分:

  1. 新特性
  2. 优化
  3. 缺陷修复
  4. 贡献者名单

8 发布掘金文章(可选)

一般每个月发布一次即可。

参考以下文章的格式:

Clone this wiki locally