bumpversion-kando 0.5.5

全局配置

常规配置分组在[bumpversion]部分中。

当前版本 =

无默认值（必填）

碰撞前软件包的当前版本。

也可用作--current-version (例如bumpversion --current-version 0.5.1 patch setup.py )

新版本 =

无默认值（可选）

增量后的软件包版本。如果没有给出将自动确定。

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

标签 = (真|假)

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

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

也可以在命令行中作为(--tag | --no-tag) 使用。

标签名 =

默认值： v{new_version}

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

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

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

提交=（真|假）

默认值： False（不创建提交）

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

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

消息=

默认值： 凹凸版本：{current_version} → {new_version}

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

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

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

零件特定配置

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

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

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

以下选项在部件配置中有效：

价值观 =

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

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

例子：

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

可选值 =

默认值： 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 版本会将1.alpha 提升到1.beta。再次执行 bumpversion release会将1.beta 提高到1，因为 发布为gamma是可选的。

第一个值 =

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

当部件复位时，该值将设置为此处指定的值。

文件特定配置

[凹凸版本：文件：…]

解析 =

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

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

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

也可用作--parse

序列化 =

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

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

这是使用Python Format String Syntax模板化的。在模板上下文中可用的是parse =中指定的命名组的解析值以及所有环境变量（以 $为前缀）。

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

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

鉴于上面的示例，新版本1.9将被序列化为 1.9，但版本2.0将被序列化为2。

也可用作--serialize。命令行上给出多个值，例如--serialize {major}.{minor} --serialize {major}

搜索 =

默认值： {current_version}

模板字符串如何在文件中搜索要替换的字符串。如果存在最遥远的可能性，即当前版本号可能在文件中出现多次，并且您的意思是只碰撞其中一个，则很有用。可以是多行，使用Python 格式字符串语法进行模板化。

替换 =

默认值： {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 格式字符串语法进行模板化。