tbump 项目使用教程

tbump 项目使用教程

tbumpBump software releases项目地址:https://gitcode.com/gh_mirrors/tb/tbump

1. 项目的目录结构及介绍

tbump 项目的目录结构如下：

tbump/
├── README.md
├── setup.py
├── tbump/
│   ├── __init__.py
│   ├── cli.py
│   ├── config.py
│   ├── git.py
│   ├── hooks.py
│   ├── patch.py
│   └── version.py
└── tests/
    ├── __init__.py
    ├── test_cli.py
    ├── test_config.py
    ├── test_git.py
    ├── test_hooks.py
    ├── test_patch.py
    └── test_version.py

• README.md: 项目说明文档。
• setup.py: 项目安装脚本。
• tbump/: 项目的主要代码目录。
  • __init__.py: 初始化文件。
  • cli.py: 命令行接口实现。
  • config.py: 配置文件处理。
  • git.py: Git 操作相关。
  • hooks.py: 钩子处理。
  • patch.py: 文件补丁处理。
  • version.py: 版本处理。
• tests/: 测试代码目录。

2. 项目的启动文件介绍

项目的启动文件是 tbump/cli.py。这个文件包含了命令行接口的实现，负责解析用户输入的命令并调用相应的功能模块。

3. 项目的配置文件介绍

tbump 项目的配置文件是 tbump.toml。这个文件用于配置版本更新的相关信息，包括当前版本、版本更新的消息模板、标签模板以及需要更新的文件列表。

一个典型的 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"

• [version]: 定义当前版本和版本号的正则表达式。
• [git]: 定义版本更新时的消息模板和标签模板。
• [[file]]: 定义需要更新的文件路径。

通过这个配置文件，tbump 可以自动更新指定文件中的版本号，并执行 Git 提交和标签操作。

tbumpBump software releases项目地址:https://gitcode.com/gh_mirrors/tb/tbump