版本号更新
本章节介绍了版本号更新操作方法。
版本号更新手动流程
版本号更新流程:
develop切release分支 → 修改并提交版本号 → 全量测试(单元/集成/回归)→ 修复测试问题(若有)→ 再次测试直到通过 → 清理工作目录 → 打annotated tag → 编译发布产物 → 推送 tag/分支 → 合并主线
详细步骤如下:
从develop切换出release/v1.0.1分支
git checkout develop git pull origin develop git checkout -b release/v1.0.1
对项目中多个配置文件中的版本号变量进行修改, 版本号需符合语义化版本(SemVer)规范。 可参考.bumpversion.toml中的配置文件,找到需要修改的版本号变量和文件位置
更新CHANGELOG.md中的新版本变更日志信息
提交版本变量和日志变更信息的修改, 提交信息可以是: Bump version: v1.0.0 -> v1.0.1
进行发布前最后的测试
cicd/run-cicd.sh
确保当前git工作目录没有尚未提交的代码, 保证git仓库是clean状态
推送分支代码和tag标签, 并合并回master和develop分支
先推送release分支和tag:
git push origin release/v1.0.1 git push origin v1.0.1
合并到master分支:
git checkout master git pull origin master git merge --no-ff release/v1.0.1
合并后推送master分支:
git push origin master
合并到develop分支:
git checkout develop git pull origin develop git merge --no-ff release/v1.0.1
若有冲突,解决冲突后提交,再推送develop分支:
git push origin develop
编译文档、wheel包、容器等 (也可通过CICD进行)
build-scripts/build-images.sh
版本号更新一键自动化命令
为了简化上述手动版本号更新步骤,可以使用下列命令一键完成版本升级
# 手动升级版本号名称
./cicd/release-version.py -n 1.0.1
或者
# 自动升级版本号, 需要指定是对major、minor、patch、num版本进行自动版本号+1升级
# 默认会先从预发布版本号alpha.1开始,通过stage命令,会逐步从alpha、beta、rc、stable版本进行升级
./cicd/release-version.py -p [major | minor | patch | num | stage]
# 完整示例 (社区正式版本)
./cicd/release-version.py -n 1.0.1
或者
./cicd/release-version.py -p patch
# 完整示例 (社区预发布版本)
./cicd/release-version.py -n 1.0.1-alpha.1
./cicd/release-version.py -n 1.0.1-beta.1
./cicd/release-version.py -n 1.0.1-rc.1
./cicd/release-version.py -p patch
./cicd/release-version.py -p num
./cicd/release-version.py -p stage
# 完整示例 (内部)
./cicd/release-version.py -n 1.0.1 --master-branch master --develop-branch dev_gitee --release-branch release_BC-QSE_V1.0.1_20251219
预发布版本和正式版本之间的命令和版本号迁移关系
当前版本 |
执行命令 |
目标版本 |
说明 |
|---|---|---|---|
1.0.0 |
release-version.sh -p patch |
1.0.1-alpha.1 |
开启新的 patch 开发周期 |
1.0.1-alpha.1 |
release-version.sh -p num |
1.0.1-alpha.2 |
增加 alpha 修订号 |
1.0.1-alpha.2 |
release-version.sh -p stage |
1.0.1-beta.1 |
推进到 beta 阶段 |
1.0.1-beta.1 |
release-version.sh -p stage |
1.0.1-rc.1 |
推进到 rc 阶段 |
1.0.1-rc.1 |
release-version.sh -p stage |
1.0.2 |
推进到 stable正式 阶段 |
注意: 建议在使用命令前先进行试运行, 加上试运行(--dry-run)参数
# 试运行
./cicd/release-version.py --dry-run -n 1.0.1