changelog

name	changelog
description	Manage changelog fragments and releases.

changelog

Record user-facing changes as YAML fragments in changelogs/fragments/. antsibull-changelog folds them into CHANGELOG.rst.

Add a fragment

Create changelogs/fragments/{{ name }}.yml, keyed by antsibull section (a list per section):

minor_changes:
  - {{ module_or_role }} - add X (https://github.com/.../pull/NNN).

Sections:

• breaking_changes
• bugfixes
• deprecated_features
• known_issues
• major_changes
• minor_changes
• release_summary (a string, prelude)
• removed_features
• security_fixes
• trivial (not rendered)

Commands

source venv/bin/activate
antsibull-changelog lint
antsibull-changelog lint-changelog-yaml --strict changelogs/changelog.yaml
antsibull-changelog generate

• generate doesn't touch fragments or show pending ones.
• lint-changelog-yaml validates the generated changelog data used to render CHANGELOG.rst.

Release fragments

After bumping version in galaxy.yml, consume the fragments from the activated virtualenv:

antsibull-changelog release

With keep_fragments: false, release records the galaxy.yml version and deletes the consumed fragments. Review CHANGELOG.rst and changelogs/changelog.yaml, then run both lint commands again before tagging.

Dependencies

• virtualenv skill