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

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

注意

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

了解 antsibull-changelog

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

有关完整详细信息，请参阅 创建变更日志片段 和 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 中提取变更日志详细信息，因此你的变更日志必须包含在 Galaxy 上包含在即将发布的 Ansible 版本中的集合版本中。

另请参阅

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

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

使用 Ansible 集合

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

为 Ansible 维护的集合贡献代码

为选定集合贡献代码的指南

邮件列表

开发邮件列表

实时聊天

如何加入 Ansible 聊天频道