Skip to content

新版本发布流程

Jump to bottom
Kagol edited this page Nov 23, 2022 · 6 revisions

一般一周发布一次版本。

版本发布流程概览

  1. 确定版本号
  2. 代码检视&合入dev分支
  3. 部署测试网站（自动化）
  4. 测试没问题再由dev合入main分支，并部署现网
  5. 发布npm
  6. 打tag
  7. 编写Release Notes（自动生成）
  8. 发布掘金文章（可选）

1 确定版本号

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

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

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

参考：

语义化版本控制规范（SemVer）

2 代码检视&合入

基本步骤：

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

3 部署测试网站

该版本涉及的PR合入dev分支之后就可以部署测试网站、发布alpha测试版本。

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

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

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

基本测试步骤：

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

4 部署现网

dev分支合入main分支，然后用main分支部署现网。

目前部署在： https://vue-devui.github.io/

部署在以下仓库： https://github.com/vue-devui/vue-devui.github.io

5 发布npm

pnpm build:lib
# 构建产物在packages/devui-vue/build中，需要修改版本号

# 在packages/devui-vue/build下执行
npm publish

6 打tag

执行以下命令：

git tag -a 'v1.0.1' -m "fix bugs"
git push origin v1.0.1

tag列表：

https://github.com/DevCloudFE/vue-devui/tags

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

7 自动生成Release Notes

可使用Generate release notes自动生成，在以下链接：

https://github.com/DevCloudFE/vue-devui/releases

  • 点击按钮Draft a new release
  • 在Choose a tag中选择上一步创建的tag名称
  • Release title中输入tag名称（比如v1.0.1）
  • 点击按钮Generate release notes即可自动生成 Release notes
  • 最后点击按钮Publish release即可创建 Release notes，如果有错误之处，也可以再次编辑

分成以下部分：

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

8 发布掘金文章（可选）

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

参考以下文章的格式：

Clone this wiki locally