在集合中生成变更日志和移植指南条目
您可以创建和共享集合的变更日志和移植指南条目。如果您的集合是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文档以了解完整详情。
注意
集合维护者为其集合设置变更日志策略。请参阅各个集合的贡献指南以了解完整详情。
生成变更日志
初始化变更日志生成
安装
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沟通指南