Changelog requirements

Collections must include a changelog that documents changes between versions. The changelog must include an entry for the version being submitted for certification. The changelog can be a file in the repository, release notes on a website, or any other publicly accessible format.

The collection README must reference the changelog from a Changelog or Release notes section.

Generating changelogs

The antsibull-changelog tool can generate changelogs from fragment files and is widely used across Ansible collections.

If a changelog tool is not practical for a given release, a summary of changes in the README under a Changelog or Release notes heading is an acceptable alternative.