BumpVer 开源项目教程

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

BumpVer 项目的目录结构如下：

bumpver/
├── bumpver/
│   ├── __init__.py
│   ├── cli.py
│   ├── config.py
│   ├── version.py
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_cli.py
│   ├── test_config.py
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── pyproject.toml
└── setup.py

目录结构介绍

• bumpver/: 项目的主代码目录，包含主要的 Python 模块和脚本。
  • __init__.py: 初始化文件，使目录成为一个 Python 包。
  • cli.py: 命令行接口的实现。
  • config.py: 配置文件处理的实现。
  • version.py: 版本号处理的实现。
• tests/: 测试代码目录，包含各种测试脚本。
  • __init__.py: 初始化文件，使目录成为一个 Python 包。
  • test_cli.py: 针对命令行接口的测试。
  • test_config.py: 针对配置文件处理的测试。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• pyproject.toml: 项目配置文件，遵循 PEP 518 标准。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

项目的启动文件是 bumpver/cli.py，它实现了命令行接口，用户可以通过命令行与项目进行交互。

启动文件介绍

• cli.py: 该文件定义了命令行接口，包括版本号更新、配置文件生成等功能。用户可以通过命令行运行 bumpver 命令来使用这些功能。

3. 项目的配置文件介绍

项目的配置文件是 pyproject.toml，它包含了项目的各种配置信息。

配置文件介绍

• pyproject.toml: 该文件遵循 PEP 518 标准，定义了项目的构建系统要求和其他配置信息。以下是一个示例配置：

[bumpver]
current_version = "2020.1001a0"
version_pattern = "YYYY.BUILD[PYTAGNUM]"
commit_message = "bump version to {new_version}"
tag_message = "v{new_version}"

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

配置文件说明

• [bumpver]: 定义了版本号的相关配置，包括当前版本号、版本号模式、提交消息和标签消息。
• [bumpver.file_patterns]: 定义了需要更新版本号的文件和对应的版本号模式。

通过以上配置，用户可以自定义版本号的更新规则和需要更新的文件。