Antsibull Changelog is a Python tool designed to generate changelogs for Ansible-core and Ansible collections. It processes changelog fragments (YAML files) to produce structured changelog outputs. Currently at version 0.35.0, it undergoes active development with releases aligned to the broader Ansible ecosystem's needs and feature cycles.
pip install antsibull-changelogVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates how to programmatically parse a changelog fragment and add it to a Changelog object. While `antsibull-changelog` is primarily a CLI tool, its core components can be used for custom changelog processing within Python applications. This example shows basic interaction with fragments, which are the building blocks of the changelog.
For full changelog generation, prefer using the `antsibull-changelog` command-line interface. For programmatic use, focus on interacting with `ChangelogFragment` and `Changelog` classes for data manipulation.
Ensure your development environment is running Python 3.9 or a newer version (e.g., 3.10, 3.11, 3.12). Use a virtual environment to manage specific Python versions for your projects.
Always consult the official `antsibull-changelog` documentation for the correct changelog fragment YAML schema. Validate fragments using the `antsibull-changelog fragment --validate` command during development.