版本发布规范

版本号命名规则指南

版本号的格式为 X.Y.Z(又称 Major.Minor.Patch),递增的规则为:

  • X 表示主版本号,当 API 的兼容性变化时,X 需递增。
  • Y 表示次版本号,当增加功能时(不影响 API 的兼容性),Y 需递增。
  • Z 表示修订号,当做 Bug 修复时(不影响 API 的兼容性),Z 需递增。

详细的规则如下:

X, Y, Z 必须为非负整数,且不得包含前导零,必须按数值递增,如 1.9.0 -> 1.10.0 -> 1.11.0 0.Y.Z 的版本号表明软件处于初始开发阶段,意味着 API 可能不稳定;1.0.0 表明版本已有稳定的 API。

当API的兼容性变化时,X必须递增,Y和Z同时设置为0;当新增功能(不影响API的兼容性)或者API被标记为Deprecated时,Y必须递增,同时Z设置为0;当进行bug fix时,Z必须递增。

先行版本号(Pre-release)意味该版本不稳定,可能存在兼容性问题,其格式为:X.Y.Z.[a-c][正 整数],如 1.0.0.a1,1.0.0.b99,1.0.0.c1000。

开发版本号常用于 CI-CD,格式为 X.Y.Z.dev[正整数],如 1.0.1.dev4。

版本号的排序规则为依次比较主版本号、次版本号和修订号的数值,如 1.0.0 < 1.0.1 < 1.1.1 < 2.0.0;对于先行版本号和开发版本号,有:1.0.0.a100 < 1.0.0,2.1.0.dev3 < 2.1.0;当存 在字母时,以 ASCII 的排序来比较,如 1.0.0.a1 < 1.0.0.b1。 注意:版本一经发布,不得修改其内容,任何修改必须在新版本发布!

一些修饰的词

  • Snapshot: 版本代表不稳定、尚处于开发中的版本 Alpha: 内部版本
  • Beta: 测试版
  • Demo: 演示版
  • Enhance: 增强版
  • Free: 自由版
  • Full Version: 完整版,即正式版 LTS: 长期维护版本
  • Release: 发行版
  • RC: 即将作为正式版发布 Standard: 标准版 Ultimate: 旗舰版 Upgrade: 升级版