Bump Version - Umbraco CMS 是一个用于更新 Umbraco CMS 版本字符串的技能,会把版本号同步到所有跟踪该版本的文件中。
用途 当用户要求提升、更新或设置 Umbraco CMS 的版本号时使用,例如“bump version to 17.3.4”。如果已提供版本参数,则不应使用 AskUserQuestion;只有当 $ARGUMENTS 为空或无法解析为版本号时才需要询问用户。
参数 $ARGUMENTS 为必填项,表示目标版本字符串,例如 17.3.4、18.0.0-rc。
需要更新的文件 以下 5 个文件必须更新为新版本:
- version.json 的 "version" 字段。
- src/Umbraco.Web.UI.Client/package.json 的 "version" 字段。
- src/Umbraco.Web.UI.Client/package-lock.json 的顶层 "version" 以及 packages[""].version。
- tests/Umbraco.Tests.AcceptanceTest/package.json 的 "version" 字段。
- tests/Umbraco.Tests.AcceptanceTest/package-lock.json 的顶层 "version" 以及 packages[""].version。
注意:对于主版本升级(例如 17.x 到 18.x),src/Umbraco.Web.UI.Login/package.json 中对 @umbraco-cms/backoffice 存在插入符范围依赖(例如 ^17.2.0),需要手动更新。本技能不处理该情况——主版本升级涉及版本字符串之外的许多其他更改。
使用方式
- 解析并校验版本:从 $ARGUMENTS 提取版本,必须是有效的类 semver 字符串(例如 17.3.4、18.0.0-rc、17.4.0-preview.1)。如果未提供版本或无法解析,则询问用户目标版本。
- 读取当前版本:读取 version.json 并提取当前 "version" 值。如果当前版本已等于目标版本,则报告版本已设置并停止——不编辑、不暂存、不提交任何内容。否则显示两个版本:Bumping version: {current} -> {target}。
- 更新所有文件:更新上述 5 个文件,将旧版本替换为新版本。对于每个文件:version.json 替换 "version" 值;package.json 文件替换 "version" 值(位于文件顶部附近);package-lock.json 文件替换顶层 "version" 值以及 "packages": { "": { ... } } 块内的 "version",这些通常位于文件前约 10 行。使用定向编辑——不要重写整个文件。要精确,避免更改依赖项条目中的版本字符串。
- 验证:所有编辑完成后,在 5 个文件中 grep 目标版本值以确认所有更新正确落地:
grep -n ""version": "{version}"" version.json src/Umbraco.Web.UI.Client/package.json src/Umbraco.Web.UI.Client/package-lock.json tests/Umbraco.Tests.AcceptanceTest/package.json tests/Umbraco.Tests.AcceptanceTest/package-lock.json
预期恰好 7 处匹配(每个 package.json 和 version.json 各一处,每个 package-lock.json 两处)。 5. 暂存并提交:仅暂存这 5 个已更改文件:
git add version.json src/Umbraco.Web.UI.Client/package.json src/Umbraco.Web.UI.Client/package-lock.json tests/Umbraco.Tests.AcceptanceTest/package.json tests/Umbraco.Tests.AcceptanceTest/package-lock.json
然后使用提交信息 Bump version to {version}. 提交,将 {version} 替换为目标版本:
git commit -m "Bump version to {version}."
- 报告:输出摘要:
Version bumped to {version} in:
- version.json
- src/Umbraco.Web.UI.Client/package.json
- src/Umbraco.Web.UI.Client/package-lock.json
- tests/Umbraco.Tests.AcceptanceTest/package.json
- tests/Umbraco.Tests.AcceptanceTest/package-lock.json
Changes staged and committed.
适用场景 适用于 Umbraco CMS 仓库中需要统一更新版本号的维护流程,尤其是常规版本或预发布版本的版本号提升。
限制 主版本升级(如 17.x 到 18.x)不处理 src/Umbraco.Web.UI.Login/package.json 中对 @umbraco-cms/backoffice 的插入符范围依赖,需要手动更新;主版本升级还涉及版本字符串之外的许多其他更改。若当前版本已等于目标版本,则不做任何编辑、暂存或提交。