0.31.1

Release Summary

Bugfix release for ansible-core.

Bugfixes

• Fix namespace extraction for ansible-core modules (#184, #185).

0.31.0

Release Summary

Feature release.

Minor Changes

• Add --strict parameter to the lint-changelog-yaml subcommand to also check for extra fields that should not be there (#182).
• Declare support for Python 3.13 (#180).
• Python API: allow to extract extra data when loading changelog files, and allow to insert extra data when saving (#181).
• Python API: allow to preprocess changelog.yaml before linting (#181).

Breaking Changes / Porting Guide

• More internal code related to the old changelog format has been removed. This only potentially affects other projects which consume antsibull-changelog as a library. The sister antsibull projects antsibull-build and antsibull-docs might only be affected in older versions. Users of the antsibull-changelog CLI tool are not affected by this change (#179).

0.30.0

Release Summary

Feature release.

Minor Changes

• Allow to configure the used VCS in changelogs/config.yml. Valid choices are none (default), git, or auto. If set to git, or auto detects that the project is part of a Git repository, only non-ignored files will be copied to a temporary directory when trying to load information on Ansible modules, plugins and roles (#172, #175).
• Antsibull-changelog now depends on the new package antsibull-docutils. This should not have any visible impact, expect potentially improved MarkDown output (#174).
• Antsibull-changelog now depends on the new project antsibull-fileutils (#176).
• If you are using argcomplete global completion, you can now tab-complete antsibull-changelog command lines. See Activating global completion in the argcomplete README for how to enable tab completion globally. This will also tab-complete Ansible commands such as ansible-playbook and ansible-test (#173).

0.29.0

Release Summary

Feature release.

Minor Changes

• Add a reformat command that reformats changelogs/changelog.yaml to the current settings of changelogs/config.yaml (#169).
• Adds a new configuration option changelog_sort. This option allows sorting of changelog entries in changelogs/changelog.yaml (#165).
• Replaces numbers with constants for return codes (#77).

Removed Features (previously deprecated)

• Removes support for the deprecated classic changelog format. changes_format must now be present and set to combined for ansible-core usage, and the value classic is no longer allowed (#137).

Bugfixes

• Remove Python version check that was checking for Python >= 3.6 (instead of >= 3.9). This check is not really necessary since pyproject.toml declares requires-python, and old enough Python versions where pip does not know about requires-python will not load antsibull-changelog due to syntax errors anyway (#167).

0.28.0

Release Summary

Feature release.

Minor Changes

• There is now an option changelog_nice_yaml to prepend the YAML document start marker --- to the header of the changelogs/changelog.yaml file, and to increases indentation level on list items. This makes the file pass ansible-lint (#91, #152, #160).

0.27.0

Release Summary

Feature release.

Minor Changes

• Adds period where needed at end of new plugin short descriptions. Controlled by the add_plugin_period option in the config file (#87).

0.26.0

Release Summary

Feature release.

Minor Changes

• The Markdown output format is now compatible with python-markdown and mkdocs, as long as the pymdownx.escapeall extension is enabled (#153).

0.25.0

Release Summary

Bugfix and feature release.

Minor Changes

• Add --version flag to print package version and exit (#147).

Bugfixes

• When multiple output formats are defined and antsibull-changelog generate is used with both --output and --output-format, an error was displayed that --output-format must be specified (#149, #151).

0.24.0

Release Summary

Feature release which now allows to output MarkDown.

Minor Changes

• Allow automatically retrieving package version for hatch projects with the hatch version command (#141).
• Allow to render changelogs as MarkDown. The output formats written can be controlled with the output_formats option in the config file (#139).
• Officially support Python 3.12 (#134).

Deprecated Features

• Some code in antsibull_changelog.changelog_entry has been deprecated, and the antsibull_changelog.rst module has been deprecated completely. If you use them in your own code, please take a look at the PR deprecating them for information on how to stop using them (#139).

0.23.0

Release Summary

Feature release.

Minor Changes

• Allow to generate changelog for a specific version (#130).
• Allow to generate only the last entry without preamble with the generate command (#131).
• Allow to write generate output to a user-provided file (#131).