antsibull-changelog¶

A changelog generator used by ansible-core and Ansible collections.

Using the antsibull-changelog CLI tool for collections.
Using the antsibull-changelog CLI tool for other projects.
Documentation on the changelogs/config.yaml configuration file for antsibull-changelog.
Documentation on the changelog.yaml format.

antsibull-changelog is covered by the Ansible Code of Conduct.

To see how antsibull-changelog changes, please look at the antsibull-changelog changelog.

Installation¶

It can be installed with pip:

pip install antsibull-changelog

For python projects, antsibull-changelog release can retrieve the current version from pyproject.toml. You can install the project with

pip install antsibull-changelog[toml]

to pull in the necessary toml parser for this feature. The toml extra is always available, but it is noop on Python >= 3.11, as tomllib is part of the standard library.

For more information, see the documentation.

License¶

Unless otherwise noted in the code, it is licensed under the terms of the GNU General Public License v3 or, at your option, later. See LICENSES/GPL-3.0-or-later.txt for a copy of the license.

The repository follows the REUSE Specification for declaring copyright and licensing information. The only exception are changelog fragments in changelog/fragments/.