tbump: 增加软件版本

安装

cargo安装 tbump

tbump 应用实例

以下是一个典型的 tbump 用法的示例

$ tbump 5.0.5
:: Bumping from 5.0.4 to 5.0.5
=> Would patch these files
- setup.py:14 version="5.0.4",
+ setup.py:14 version="5.0.5",
- tbump.toml:2 current = "5.0.4"
+ tbump.toml:2 current = "5.0.5"
=> Would run these hooks before commit
* (1/2) $ ./test.sh
* (2/2) $ grep -q 5.0.5 Changelog.rst
=> Would run these git commands
 * git add --update
 * git commit --message Bump to 5.0.5
 * git tag --annotate --message v5.0.5 v5.0.5
 * git push origin master
 * git push origin v5.0.5
=> Would run these hooks after push
* (1/1) $ ./publish.sh
:: Looking good? (y/N)
y
=> Patching files
...
=> Running hooks before commit
...
=> Making bump commit and push matching tags
...
=> Running hooks after push
...
Done ✓

用法

首先运行 tbump init。这将创建一个类似下面的 tbump.toml 文件

[version]
current = "1.2.41"
regex = '''
  (?P<major>\d+)
  \.
  (?P<minor>\d+)
  \.
  (?P<patch>\d+)
'''

[git]
message_template = "Bump to {new_version}"
tag_template = "v{new_version}"

[[file]]
src = "setup.py"

注意

• 文件使用 toml 语法。
• 一些模板必须包含使用花括号占位符的占位符
• 路径可以包含 Unix 风格的 通配符，例如 src = "a/**/script.?s" 匹配 a/b/script.js 和 a/b/c/script.ts。
• 版本正则表达式将使用 'verbose' 模式，可以包含命名组（见下文）。

一旦 tbump.toml 文件准备就绪，运行类似下面的命令

$ tbump 1.2.42

tbump 将

• 将配置中列出的每个文件中的字符串 1.2.41 替换为 1.2.42
• 基于 message_template 创建提交。
• 基于 tag_template 创建一个 注解 标签。
• 推送当前分支和标签。

注意，默认情况下，tbump 将显示所有更改，并在执行任何操作之前停止以询问是否正确，允许您在出现问题时中止并重新尝试增加版本。您可以使用 --non-interactive 来禁用此行为。

如果您只想增加文件而不执行任何 git 操作或运行钩子命令，请使用 --only-patch 选项。

高级配置

限制替换的行

有时您需要确保只有匹配给定模式的行被替换。例如，对于以下 package.json

/* in package.json */
{
   "name": "foo",
   "version": "0.42",
   "dependencies": {
     "some-dep": "0.42",
     "other-dep": "1.3",
   }
}

您想确保当您从 0.42 增加到 0.43 时，包含 some-dep 的行不会更改。

# In tbump.toml

[[file]]
src = "package.json"
search = '"version": "{current_version}"'

/* in version.js */

export FULL_VERSION = '1.2.3-alpha-4';
export PUBLIC_VERSION = '1.2.3';

[[file]]
src = "version.js"
version_template = "{major}.{minor}.{patch}"
search = "export PUBLIC_VERSION = '{current_version}'"

[[file]]
src = "version.js"
search = "export FULL_VERSION = '{current_version}'"

[[before_commit]]
name = "Check Changelog"
cmd = "grep -q {new_version} Changelog.rst"

[[after_push]]
name = "Publish to crates.io"
cmd = "cargo publish"