Ansible-core和Ansible集合的变更日志工具
项目描述
antsibull-changelog -- Ansible Changelog Tool
由ansible-core和Ansible collections使用的变更日志生成器。
- 使用
antsibull-changelogCLI工具为collections生成。 - 使用针对其他项目的
antsibull-changelogCLI 工具。 - 关于
changelogs/config.yaml配置文件 的文档。 - 关于
changelog.yaml格式 的文档。
antsibull-changelog 受 Ansible 行为准则 的约束。
社区
需要帮助或想讨论该项目？请参阅我们的 社区指南，了解如何加入对话！
安装
可以使用 pip 进行安装。
pip install antsibull-changelog
对于 Python 项目，antsibull-changelog release 可以从 pyproject.toml 获取当前版本。您可以使用以下命令安装项目：
pip install antsibull-changelog[toml]
来拉取此功能所需的 toml 解析器。`toml` 扩展始终可用，但在 Python >= 3.11 上它是一个无操作，因为 `tomllib` 是标准库的一部分。
有关更多信息，请参阅 文档。
开发
安装并运行 nox 以运行所有测试。简单的贡献就此结束！nox 将在已签出的项目中的 .nox 目录下创建虚拟环境，并安装运行测试所需的要求。
antsibull-changelog 依赖于姐妹项目 antsibull-docutils 和 antsibull-fileutils。默认情况下，nox 将从 Github 安装这些项目的开发版本。如果您在 antsibull-changelog 旁边修改 antsibull-docutils 和/或 antsibull-fileutils，当运行测试时，如果这些路径存在，nox 将自动从 ../antsibull-docutils 和 ../antsibull-fileutils 安装这些项目。您可以通过 OTHER_ANTSIBULL_MODE 环境变量更改此行为。
OTHER_ANTSIBULL_MODE=auto—— 如上所述的默认行为OTHER_ANTSIBULL_MODE=local—— 从../antsibull-docutils和../antsibull-fileutils安装项目。如果这些路径不存在，则失败。OTHER_ANTSIBULL_MODE=git—— 从 Github 的主分支安装项目OTHER_ANTSIBULL_MODE=pypi—— 从 PyPI 安装最新版本
运行特定测试
nox -e test仅运行单元测试；nox -e integration仅运行集成测试；这将运行antsibull-changelog lint对 antsibull-changelog 和 community.general（在克隆其存储库后）进行测试，并记录覆盖率数据。nox -e coverage在运行nox -e test integration后显示合并后的覆盖率结果；nox -e lint一次性运行所有检查器和格式化程序；nox -e formatters运行isort和black；nox -e codeqa运行flake8、pylint、reuse lint和antsibull-changelog lint；nox -e typing运行mypy。
创建新版本
- 运行
nox -e bump -- <version> <release_summary_message>。这将- 在
src/antsibull_changelog/__init__.py中提升软件包版本。 - 创建带有
release_summary节的changelogs/fragments/<version>.yml。 - 运行
antsibull-changelog release并将更改的文件添加到 git。 - 提交消息为
发布 <version>并运行git tag -a -m 'antsibull-changelog <version>' <version>。 - 运行
hatch build --clean。
- 在
- 运行
git push到适当的远程仓库。 - 一旦 CI 在 GitHub 上通过，运行
nox -e publish。这将- 运行
hatch publish； - 将版本提升到
<version>.post0； - 将更改的文件添加到 git 并运行
git commit -m '发布版本提升.'；
- 运行
- 运行
git push --follow-tags到适当的远程仓库并创建 GitHub 发布。
许可证
除非代码中另有说明，否则该软件根据GNU通用公共许可证v3版或您选择的更高版本进行许可。请参阅LICENSES/GPL-3.0-or-later.txt获取许可证副本。
仓库遵循REUSE规范来声明版权和许可信息。唯一的例外是位于changelog/fragments/的变更日志片段。
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解更多关于安装包的信息。
源分发
构建分发
antsibull_changelog-0.30.0.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 37660a748cf2597ba9cdf26172ceac87ca5c227e693f50b4592da71c45c0bb74 |
|
| MD5 | f33dacef3dfe4764269460179b8ca49c |
|
| BLAKE2b-256 | 7395c827a1d26eedff99a636aa13f220e9d5e65c0484de332ecab04be7eef312 |
antsibull_changelog-0.30.0-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 5ae38c10366d5226e5358ee3265e5dddde0b1b36e45970429e4ce3186f178426 |
|
| MD5 | f28b2fb549626a0707d517e01e79e682 |
|
| BLAKE2b-256 | dcb26a6ed5c594744419f9a7be353b8de84707e206573a5a990d26675446e72c |
