antsibull-changelog -- Ansible Changelog Tool

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.

Community

Need help or want to discuss the project? See our Community guide to learn how to join the conversation!

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.

Development

Install and run nox to run all tests. That's it for simple contributions! nox will create virtual environments in .nox inside the checked out project and install the requirements needed to run the tests there.

antsibull-changelog depends on the sister antsibull-docs-parser, antsibull-docutils, and antsibull-fileutils projects. By default, nox will install a development version of these projects from Github. If you're hacking on antsibull-docs-parser, antsibull-docutils, and/or antsibull-fileutils alongside antsibull-changelog, nox will automatically install these projects from ../antsibull-docs-parser, ../antsibull-docutils, and ../antsibull-fileutils when running tests if those paths exist. You can change this behavior through the OTHER_ANTSIBULL_MODE env var:

OTHER_ANTSIBULL_MODE=auto — the default behavior described above
OTHER_ANTSIBULL_MODE=local — install the projects from ../antsibull-docs-parser, ../antsibull-docutils, and ../antsibull-fileutils. Fail if those paths don't exist.
OTHER_ANTSIBULL_MODE=git — install the projects from the Github main branch
OTHER_ANTSIBULL_MODE=pypi — install the latest versions from PyPI

To run specific tests:

nox -e test to only run unit tests;
nox -e integration to only run integration tests; this runs antsibull-changelog lint against antsibull-changelog and community.general (after cloning its repository) and records coverage data.
nox -e coverage to display combined coverage results after running nox -e test integration;
nox -e lint to run all linters and formatters at once;
nox -e formatters to run isort and black;
nox -e codeqa to run flake8, pylint, reuse lint, and antsibull-changelog lint;
nox -e typing to run mypy.

Creating a new release:

Run nox -e bump -- <version> <release_summary_message>. This:
- Bumps the package version in src/antsibull_changelog/__init__.py.
- Creates changelogs/fragments/<version>.yml with a release_summary section.
- Runs antsibull-changelog release and adds the changed files to git.
- Commits with message Release <version>. and runs git tag -a -m 'antsibull-changelog <version>' <version>.
- Runs hatch build --clean.
Run git push to the appropriate remotes.
Once CI passes on GitHub, run nox -e publish. This:
- Runs hatch publish;
- Bumps the version to <version>.post0;
- Adds the changed file to git and run git commit -m 'Post-release version bump.';
Run git push --follow-tags to the appropriate remotes and create a GitHub release.

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/.

Metadata

Release files for antsibull-changelog 0.36.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for antsibull-changelog 0.36.0
File	Size	Uploaded	Provenance
antsibull_changelog-0.36.0.tar.gz	145.7 kB	Oct 25, 2026	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for antsibull-changelog 0.36.0
File	Interpreter	ABI	Platform	Reset
antsibull_changelog-0.36.0-py3-none-any.whl 74.5 kB Oct 25, 2026 Without provenance	Python 3	none	any	Details

Total release size: 220.2 kB

Release files / antsibull_changelog-0.36.0.tar.gz

Download URL	antsibull_changelog-0.36.0.tar.gz
Size	145.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`f448fb6bae539d3bf6b8c68c8f94622aba3efddba3e9a40d5c3820356af0f686`
BLAKE2b-256 checksum How to use checksums	`b590c374a7d2fabfb7707dc52d64d61bf892438296be53a21094471a3bc655a3`
Upload date	Oct 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`Hatch/1.18.1 {"ci":null,"cpu":"x86_64","distro":{"id":"n/a","libc":{"lib":"glibc","version":"2.44"},"name":"Arch Linux","version":"rolling"},"implementation":{"name":"CPython","version":"3.14.8"},"installer":{"name":"hatch","version":"1.18.1"},"openssl_version":"OpenSSL 3.6.5 29 Sep 2026","python":"3.14.8","system":{"name":"Linux","release":"7.2.7-arch1-1"}} HTTPX2/2.16.0`

Release files / antsibull_changelog-0.36.0-py3-none-any.whl

Download URL	antsibull_changelog-0.36.0-py3-none-any.whl
Size	74.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`2e5e1bcd0d0f8ba3ec95ea67ce71f8751e5904ca3dcdda23e075c79a8a60a0f2`
BLAKE2b-256 checksum How to use checksums	`df3e53c1ab8eb50febf5d6ac30e91b40c9e9ab594434689b451d95f106a8d08f`
Upload date	Oct 25, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`Hatch/1.18.1 {"ci":null,"cpu":"x86_64","distro":{"id":"n/a","libc":{"lib":"glibc","version":"2.44"},"name":"Arch Linux","version":"rolling"},"implementation":{"name":"CPython","version":"3.14.8"},"installer":{"name":"hatch","version":"1.18.1"},"openssl_version":"OpenSSL 3.6.5 29 Sep 2026","python":"3.14.8","system":{"name":"Linux","release":"7.2.7-arch1-1"}} HTTPX2/2.16.0`

Security for antsibull-changelog 0.36.0

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.