BumpVer 版本管理工具教程

项目介绍

BumpVer 是一个用于自动管理项目版本号的工具，支持多种版本格式，如 CalVer 和 SemVer。它可以帮助开发者在项目发布新版本时，自动更新版本号，并支持在多个文件中同步更新版本信息。BumpVer 由 Manuel Barkhau 开发，遵循 MIT 许可证。

项目快速启动

安装 BumpVer

首先，你需要安装 BumpVer。可以通过 pip 进行安装：

pip install bumpver

初始化配置

进入你的项目目录，初始化 BumpVer 配置：

cd myproject
bumpver init

这将会生成一个 bumpver.toml 配置文件，你可以根据需要进行修改。

更新版本号

假设你已经配置好了 bumpver.toml，你可以使用以下命令来更新版本号：

bumpver update --patch

这将把版本号更新为下一个补丁版本。

应用案例和最佳实践

应用案例

假设你有一个 Python 项目，版本号存储在 setup.py 和 src/mymodule/__init__.py 中。你可以这样配置 bumpver.toml：

[bumpver]
current_version = "1.5.2"
version_pattern = "MAJOR.MINOR.PATCH"

[bumpver.file_patterns]
"setup.py" = [
    'version="{version}"'
]
"src/mymodule/__init__.py" = [
    '__version__ = "{version}"'
]

然后运行 bumpver update --minor 来更新次版本号。

最佳实践

1. 自动化版本更新：在 CI/CD 流程中集成 BumpVer，每次发布新版本时自动更新版本号。
2. 版本策略：根据项目特点选择合适的版本策略（如 CalVer 或 SemVer），并在团队中统一使用。
3. 文档更新：确保每次版本更新时，相关文档和 CHANGELOG 也得到更新。

典型生态项目

BumpVer 可以与以下项目集成，以实现更高效的版本管理：

1. Git：通过 Git 钩子在提交代码时自动更新版本号。
2. CI/CD 工具（如 Jenkins, GitHub Actions）：在 CI/CD 流程中自动执行版本更新和发布。
3. 文档生成工具（如 Sphinx, MkDocs）：在生成文档时自动包含最新版本号。

通过这些集成，你可以实现从代码提交到版本发布的全自动化流程，提高开发效率。