Convbump

convbump 是一个用于处理常规提交的简单工具。

使用 version 命令根据常规提交在您的存储库中查找下一个版本。

使用 changelog 命令生成一个格式良好的变更日志（兼容Github markdown）。

需求

convbump 没有任何外部依赖。

convbump 使用纯Python库来访问Git存储库，因此不需要 git 可执行文件。

开发

应用程序是用Python编写的，并使用 Poetry 配置包并管理其依赖项。

确保您已经安装了 Poetry CLI。然后您可以运行

$ poetry install

这将安装项目依赖项（包括 dev 依赖项）到由Poetry管理的Python虚拟环境中（或者，您可以先激活您自己的虚拟环境，然后Poetry将使用它）。

使用pytest运行测试

$ poetry run pytest

或

$ poetry shell
$ pytest

pytest 首先会从存在的 pytest.ini 文件中获取配置，然后从 pyproject.toml。将任何本地配置添加到 pytest.ini。在 pyproject.toml 中的配置将在 CI 中使用。您可以通过与 CI 相同的方式运行测试来捕获任何错误。

$ pytest -c pyproject.toml

代码格式化

应用程序使用 black 和 isort 进行格式化。
您可以手动运行 black 和 isort，或者使用准备好的 Poe 任务来格式化整个项目。

$ poetry run poe format-code

或

$ poetry shell
$ poe format-code