在集合中生成变更日志和移植指南条目
您可以为您的集合创建和共享变更日志和移植指南条目。如果您的集合是 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 文档。
注意
集合维护者为他们的集合设置变更日志策略。有关完整详细信息，请参阅各个集合的贡献指南。
生成变更日志
要初始化变更日志生成
安装
antsibull-changelog：pip install antsibull-changelog。为您的存储库初始化变更日志：
antsibull-changelog init <path/to/your/collection>。可选地，编辑
changelogs/config.yaml文件以自定义生成的变更日志.rst文件的位置或其他选项。有关详细信息，请参阅 为集合引导变更日志。
要从您创建的变更日志片段生成变更日志
可选地，验证您的变更日志片段：
antsibull-changelog lint。为您的版本生成变更日志：
antsibull-changelog release [--version version_number]。
注意
如果您之前运行过 antsibull-changelog release 命令并且集合的版本没有更改，则添加 --reload-plugins 选项。 antsibull-changelog 会缓存所有插件的信息，并且不会更新其缓存，直到集合版本发生更改。
从变更日志片段生成移植指南条目
Ansible 变更日志生成器会自动将多个变更日志片段类别添加到 Ansible 移植指南中
重大更改重大变更已弃用功能已删除功能
将集合变更日志包含到 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 沟通指南