uv-dynamic-versioning 开源项目最佳实践教程

1. 项目介绍

uv-dynamic-versioning 是一个动态版本管理工具，专为使用 uv 或 hatch 的项目设计。它基于版本控制系统（VCS）的标签来管理版本，适用于单项目和多项目（monorepo）环境。uv-dynamic-versioning 利用 dunamai 库的强大功能，为项目提供灵活的版本管理方案。

2. 项目快速启动

以下是快速启动 uv-dynamic-versioning 的步骤：

首先，确保你的项目已经配置了 hatch 作为构建系统。在 pyproject.toml 文件中，添加以下内容：

[build-system]
requires = [
    "hatchling",
    "uv-dynamic-versioning"
]
build-backend = "hatchling.build"

接下来，安装必要的依赖：

pip install hatchling uv-dynamic-versioning

在 pyproject.toml 文件中配置版本源插件和元数据钩子插件：

[tool.hatch.version]
source = "uv-dynamic-versioning"

[tool.hatch.metadata.hooks]
uv_dynamic_versioning = {
    "import": "uv_dynamic_versioning.hooks",
    "hook": "set_version"
}

现在，每次构建项目时，uv-dynamic-versioning 都会根据 VCS 标签自动设置版本号。

3. 应用案例和最佳实践

动态版本设置

uv-dynamic-versioning 允许你根据 VCS 标签动态设置版本号。以下是一个简单的例子：

from uv_dynamic_versioning import get_next_version

version = get_next_version()
print(f"当前版本: {version}")

Monorepo 环境中的依赖管理

在 Monorepo 环境中，你可以使用 uv-dynamic-versioning 的元数据钩子插件动态设置依赖项。例如，根据不同的 VCS 版本号，你可以为不同的子项目设置不同的依赖版本：

from uv_dynamic_versioning import set_version

version = set_version()
# 根据 version 设置依赖项

版本回滚

uv-dynamic-versioning 也支持版本回滚。如果需要回滚到上一个版本，可以使用以下命令：

hatch version --rollback

4. 典型生态项目

以下是一些使用 uv-dynamic-versioning 的典型生态项目：

• microsoft/essex-toolkit：使用版本源插件。
• modelcontextprotocol/python-sdk：使用版本源插件。
• pydantic/pydantic-ai：使用版本源和元数据钩子插件。

通过以上最佳实践，你可以更好地利用 uv-dynamic-versioning 为你的项目提供高效的版本管理。