bumpversion 0.6.0

全局配置

一般配置分组在[bumpversion]部分中。

current_version =

无默认值（必填）

提升前的软件包当前版本。

也可作为--current-version使用（例如，bumpversion --current-version 0.5.1 patch setup.py）

new_version =

无默认值（可选）

提升后的软件包版本。如果没有提供，将自动确定。

也可作为--new-version使用（例如，要直接从0.5.1提升到0.6.1：bumpversion --current-version 0.5.1 --new-version 0.6.1 patch setup.py）。

tag = (True | False)

默认值： False （不创建标签）

是否创建标签，即以字符“v”为前缀的新版本。如果你使用git，不要忘记使用带有--tags标志的git-push。

也可在命令行上作为(--tag | --no-tag)

tag_name =

默认值： v{new_version}

要创建的标签的名称。仅当使用--tag / tag = True时有效。

这是使用Python 格式化字符串语法进行模板化的。在模板上下文中可用的是current_version和new_version以及所有环境变量（以$为前缀）。您还可以使用变量now或utcnow来获取当前时间戳。两者都接受日期时间格式（当用作如{now:%d.%m.%Y}时）。

也可作为 --tag-name 使用（例如：bumpversion --message 'Jenkins Build {$BUILD_NUMBER}: {new_version}' patch）。

commit = (True | False)

默认： False （不创建提交）

是否使用 git 或 Mercurial 创建提交。

也可作为 (--commit | --no-commit) 使用。

message =

默认： Bump version: {current_version} → {new_version}

创建提交时使用的提交信息。仅在使用 --commit / commit = True 时有效。

这是使用Python 格式化字符串语法进行模板化的。在模板上下文中可用的是current_version和new_version以及所有环境变量（以$为前缀）。您还可以使用变量now或utcnow来获取当前时间戳。两者都接受日期时间格式（当用作如{now:%d.%m.%Y}时）。

也可作为 --message 使用（例如：bumpversion --message '[{now:%Y-%m-%d}] Jenkins Build {$BUILD_NUMBER}: {new_version}' patch）

特定配置部分

版本字符串由一个或多个部分组成，例如版本 1.0.2 有三个部分，由点（.）字符分隔。在默认配置中，这些部分被命名为 major、minor、patch，但您可以使用 parse/serialize 选项来自定义。

默认情况下，所有部分被视为数字，即它们的初始值是 0，并以整数形式增加。此外，如果不需要序列化，则值 0 被视为可选，即它在不提供 {major}.{minor} 作为 serialize 值时，版本 1.4.0 等于 1.4。

对于高级版本管理方案，可能需要非数字部分（例如，为了标识 alpha 或 beta 版本、表示开发阶段、软件包的风味或发布名称）。为此，您可以使用包含部分名称的 [bumpversion:part:…] 部分（例如，名为 release_name 的部分配置在名为 [bumpversion:part:release_name] 的部分中）。

以下选项在部分配置内有效

values =

默认： 数字（即 0、1、2、…）

将迭代特定部分的所有值的显式列表。

示例

[bumpversion:part:release_name]
values =
  witty-warthog
  ridiculous-rat
  marvelous-mantis

optional_value =

默认： values = 的第一个条目。

如果部分值与此值匹配，则它被视为可选，即它在不提供 --serialize 可能性时，其表示不是必需的。

示例

[bumpversion]
current_version = 1.alpha
parse = (?P<num>\d+)\.(?P<release>.*)
serialize =
  {num}.{release}
  {num}

[bumpversion:part:release]
optional_value = gamma
values =
  alpha
  beta
  gamma

在此，bumpversion release 会将 1.alpha 升级到 1.beta。再次执行 bumpversion release 会将 1.beta 升级到 1，因为 release 被配置为可选。

first_value =

默认： values = 的第一个条目。

当部分重置时，值将被设置为这里指定的值。

文件特定配置

[bumpversion:file:…]

parse =

默认： (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)

正则表达式（使用 Python 正则表达式语法）用于查找和解析版本字符串。

需要解析由 serialize = 产生的所有字符串。命名匹配组（“(?P<name>...)”）作为 part 参数提供值。

也作为 --parse 使用。

serialize =

默认值: {major}.{minor}.{patch}

模板指定如何将版本部分序列化为版本字符串。

这是使用 Python 格式字符串语法 模板化的。在模板上下文中，可用的是在 parse = 中指定的命名组的解析值以及所有环境变量（以 $ 为前缀）。

可以指定多次，bumpversion 将尝试从第一个开始的序列化格式，并选择最后一个所有值都可以这样表示的格式。

serialize =
  {major}.{minor}
  {major}

给定上面的例子，新版本 1.9 将序列化为 1.9，但版本 2.0 将序列化为 2。

也作为 --serialize 使用。命令行上的多个值给出如 --serialize {major}.{minor} --serialize {major}

search =

默认值: {current_version}

模板字符串，用于在文件中搜索要替换的字符串。如果当前版本号可能在文件中出现多次，并且你只想更改其中一个出现，则很有用。可以是多行，使用 Python 格式字符串语法 模板化。

replace =

默认值: {new_version}

用于在文件中替换当前版本号的字符串模板。

给定这个 requirements.txt

Django>=1.5.6,<1.6
MyProject==1.5.6

使用这个 .bumpversion.cfg 将确保只更改包含 MyProject 的行

[bumpversion]
current_version = 1.5.6

[bumpversion:file:requirements.txt]
search = MyProject=={current_version}
replace = MyProject=={new_version}

可以是多行，使用 Python 格式字符串语法 模板化。