在集合中生成变更日志和移植指南条目

您可以为您的集合创建和共享变更日志和移植指南条目。如果您的集合是 Ansible 社区软件包的一部分，我们建议您使用 antsibull-changelog 工具来生成与 Ansible 兼容的变更日志。Ansible 变更日志使用此工具的输出来整理 Ansible 版本中包含的所有集合，从而为该版本创建一个组合的变更日志。

注意

这里的 Ansible 指的是包含一组精选集合的 Ansible 2.10 或更高版本。

了解 antsibull-changelog

antsibull-changelog 工具允许您为与组合的 Ansible 变更日志兼容的 Ansible 集合创建和更新变更日志。这是对先前 Ansible 版本中使用的变更日志生成器的更新。该工具添加了三个新的变更日志片段类别：breaking_changes、security_fixes 和 trivial。该工具还会生成 changelog.yaml 文件，Ansible 使用该文件来创建组合的 CHANGELOG.rst 文件和该版本的移植指南。

有关完整详细信息，请参阅创建变更日志片段和 antsibull-changelog 文档。

注意

集合维护者为他们的集合设置变更日志策略。有关完整详细信息，请参阅各个集合的贡献指南。

生成变更日志

要初始化变更日志生成

  1. 安装 antsibull-changelog：pip install antsibull-changelog。

  2. 为您的存储库初始化变更日志：antsibull-changelog init <path/to/your/collection>。

  3. （可选）编辑 changelogs/config.yaml 文件以自定义生成的变更日志 .rst 文件或其他选项的位置。有关详细信息，请参阅为集合引导变更日志。

要从您创建的变更日志片段生成变更日志

  1. （可选）验证您的变更日志片段：antsibull-changelog lint。

  2. 为您的版本生成变更日志：antsibull-changelog release [--version version_number]。

注意

如果您之前运行过 antsibull-changelog release 命令，并且集合的版本没有更改，请添加 --reload-plugins 选项。antsibull-changelog 会缓存有关所有插件的信息，并且在集合版本更改之前不会更新其缓存。

从变更日志片段生成移植指南条目

Ansible 变更日志生成器会自动将几个变更日志片段类别添加到 Ansible 移植指南中

  • major_changes

  • breaking_changes

  • deprecated_features

  • removed_features

将集合变更日志包含到 Ansible 中

如果您的集合是 Ansible 的一部分，请使用以下三个选项之一将您的变更日志包含到 Ansible 版本变更日志中

  • 使用 antsibull-changelog 工具。

  • 如果您不使用此工具，请将格式正确的 changelog.yaml 文件包含到您的集合中。有关详细信息，请参阅changelog.yaml 格式。

  • 通过在 https://github.com/ansible-community/ansible-build-data/ 上打开一个问题，以任何格式添加指向您自己的变更日志或发行说明的链接，并附上指向该信息的 HTML 链接。

注意

对于前两个选项，Ansible 从 Galaxy 拉取变更日志详细信息，因此您的变更日志必须包含在即将发布的 Ansible 版本中包含的 Galaxy 上的集合版本中。

另请参阅

在集合中生成变更日志和移植指南条目

了解如何创建好的变更日志片段。

使用 Ansible 集合

了解如何安装和使用集合。

为 Ansible 维护的集合做贡献

为选定的集合做贡献的指南

交流

有问题吗？需要帮助吗？想分享您的想法吗？请访问 Ansible 交流指南