Bumpversion 进阶：配置可选 dev 版本后缀

理解 Bumpversion 的版本部分递增机制

在使用 bumpversion 工具进行版本管理时，我们经常需要为开发中的版本添加特定的后缀，例如 1.5.3-dev-1。然而，当尝试将版本从 1.5.3 升级到 1.5.3-dev-1 这样的开发版本时，如果 dev 部分的配置不当，可能会遇到 valueerror: the part has already the maximum value among ['dev'] and cannot be bumped. 错误。

这个问题的根源在于 bumpversion 对其配置中定义的部分（part）的递增逻辑。当一个版本部分（如 dev）在 [bumpversion:part:dev] 配置中只包含一个 values 值时，bumpversion 会将其视为该部分的“最大值”。这意味着，如果当前版本不包含 dev 部分，而你尝试通过 bumpversion dev 命令将其“递增”到 dev 状态，bumpversion 会认为 dev 已经是其唯一且最大的值，因此无法再进行“递增”操作。

以下是可能导致此问题的典型 bumpversion 配置示例：

[bumpversion]
current_version = 1.5.3
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(-(?P<dev>.*)-(?P<build>\d+))?
serialize = 
    {major}.{minor}.{patch}-{dev}-{build}
    {major}.{minor}.{patch}

[bumpversion:part:dev]
values = 
    dev

[bumpversion:part:build]
first_value = 1

在这种配置下，执行 bumpversion dev 将会抛出上述 ValueError。

解决方案：为 dev 部分添加初始状态

要解决此问题，我们需要为 dev 部分提供一个可供“递增”的初始状态。最简单有效的方法是在 [bumpversion:part:dev] 的 values 列表中添加一个空字符串 "" 或任何其他非 dev 的占位符作为第一个值。这为 bumpversion 提供了一个“从哪里来”的状态，使其能够顺利地“递增”到 dev 状态。

修正后的 bumpversion:part:dev 配置应如下所示：

[bumpversion:part:dev]
values = 
    ""
    dev

或者，你也可以使用任何其他不冲突的初始值，例如：

阶跃AI

阶跃星辰旗下AI智能问答搜索助手

291

查看详情

[bumpversion:part:dev]
values = 
    13423423
    dev

在大多数情况下，使用空字符串 "" 是最直观和推荐的做法，因为它代表了版本中不包含 dev 后缀的默认状态。

工作原理详解

当 bumpversion:part:dev 的 values 列表中包含 "" 和 dev 时：

1. 初始状态： 如果当前版本是 1.5.3，bumpversion 会识别出 dev 部分处于其 values 列表中的第一个值，即 ""（隐式地表示没有 dev 后缀）。
2. 执行 bumpversion dev： 当你运行 bumpversion dev 命令时，bumpversion 会查找 dev 部分的下一个值。由于 "" 是第一个值，dev 是第二个值，bumpversion 能够顺利地将 dev 部分从 "" “递增”到 dev。
3. 生成新版本： 最终，版本号将按照 serialize 规则生成，例如 1.5.3-dev-1（假设 build 部分也已正确配置并递增）。

重要注意事项：

• bumpversion 的版本部分递增通常是单向的，即从一个值递增到列表中的下一个值。一旦某个部分递增到 dev，它不会自动“循环”回到 "" 或其他初始状态。如果需要从 dev 状态回到非 dev 状态，通常需要手动编辑 current_version 或使用其他 bumpversion 功能进行重置。
• 确保 parse 和 serialize 配置能够正确处理包含和不包含 dev 后缀的两种版本格式。在示例中，serialize 列表包含了 {major}.{minor}.{patch}-{dev}-{build} 和 {major}.{minor}.{patch} 两种格式，这对于可选的 dev 后缀至关重要。

总结

通过在 bumpversion 配置中为可选的开发版本部分（如 dev）添加一个空字符串或占位符作为 values 列表的第一个值，可以有效解决在尝试添加该后缀时遇到的 ValueError。这一简单的配置调整为 bumpversion 提供了必要的“初始状态”，使其能够按照预期执行版本递增操作，从而实现更加灵活和健壮的版本管理流程。理解 bumpversion 的版本部分递增逻辑是充分利用其强大功能的关键。

以上就是Bumpversion 进阶：配置可选 dev 版本后缀的详细内容，更多请关注php中文网其它相关文章！