Antsibull-changelog

=======

Release Summary
---------------

Feature release.

Major Changes
-------------

- The new configuration setting ``output`` allows to configure more precisely which changelog files are generated and how they are formatted (https://github.com/ansible-community/antsibull-changelog/issues/190, https://github.com/ansible-community/antsibull-changelog/pull/194).

Minor Changes
-------------

- Antsibull-changelog now depends on Pydantic 2 (https://github.com/ansible-community/antsibull-changelog/pull/193).
- Antsibull-changelog now uses Pydantic to parse and validate the config. This means that validation is more strict than before and might reject configs that were incorrect, but still got accepted somehow (https://github.com/ansible-community/antsibull-changelog/pull/193).

Breaking Changes / Porting Guide
--------------------------------

- When using antsibull-changelog as a library, ``ChangelogConfig``'s constructor should no longer be called directly. Instead, use the class method ``ChangelogConfig.parse()``, which has the same signature than the previous constructor, except that ``ignore_is_other_project`` now must be a keyword parameter (https://github.com/ansible-community/antsibull-changelog/pull/193).
- When using antsibull-changelog as a library, ``rendering.changelog.generate_changelog()`` now needs a ``ChangelogOutput`` object instead of the ``document_format: TextFormat`` parameter, and the ``config`` and ``changelog_path`` parameters have been removed (https://github.com/ansible-community/antsibull-changelog/pull/194).
- When using the ``--output`` argument for ``antsibull-changelog generate``, the generated changelog's title will not contain any parts of the version number. If you need this, `please create an issue <https://github.com/ansible-community/antsibull-changelog/issues/new>`__ (https://github.com/ansible-community/antsibull-changelog/pull/194).

Deprecated Features
-------------------

- The configuration settings ``changelog_filename_template``, ``changelog_filename_version_depth``, and ``output_formats`` are deprecated and will eventually be removed. Use the new setting ``output`` instead. Note that there are no runtime warnings right now. If the time to remove them comes nearer, there will be runtime warnings for a longer time first before they are actually removed (https://github.com/ansible-community/antsibull-changelog/pull/194).

Removed Features (previously deprecated)
----------------------------------------

- Python API: remove ``antsibull_changelog.rst`` module (https://github.com/ansible-community/antsibull-changelog/pull/183).
- Python API: remove constructor arguments ``plugins`` and ``fragments`` from class ``ChangelogGenerator`` in ``antsibull_changelog.rendering.changelog`` (https://github.com/ansible-community/antsibull-changelog/pull/183).
- Python API: remove method ``ChangelogEntry.add_section_content``, class ``ChangelogGenerator``, and function ``generate_changelog`` from ``antsibull_changelog.changelog_generator`` (https://github.com/ansible-community/antsibull-changelog/pull/183).
- When using antsibull-changelog as a library, the fields ``changelog_filename_template``, ``changelog_filename_version_depth``, and ``output_formats`` are no longer available in ``ChangelogConfig``. Use ``output`` instead (https://github.com/ansible-community/antsibull-changelog/pull/194).

=======

Release Summary
---------------

Bugfix release.

Bugfixes
--------

- When linting found RST problems with rstcheck, the error messages were reduced to a single letter (https://github.com/ansible-community/antsibull-changelog/pull/188).

=======

Release Summary
---------------

Bugfix release for ansible-core.

Bugfixes
--------

- Fix ``namespace`` extraction for ansible-core modules (https://github.com/ansible-community/antsibull-changelog/issues/184, https://github.com/ansible-community/antsibull-changelog/pull/185).

=======

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 (https://github.com/ansible-community/antsibull-changelog/pull/182).
- Declare support for Python 3.13 (https://github.com/ansible-community/antsibull-changelog/pull/180).
- Python API: allow to extract extra data when loading changelog files, and allow to insert extra data when saving (https://github.com/ansible-community/antsibull-changelog/pull/181).
- Python API: allow to preprocess changelog.yaml before linting (https://github.com/ansible-community/antsibull-changelog/pull/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** (https://github.com/ansible-community/antsibull-changelog/pull/179).

=======

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 (https://github.com/ansible-community/antsibull-changelog/issues/172, https://github.com/ansible-community/antsibull-changelog/pull/175).
- Antsibull-changelog now depends on the new package antsibull-docutils. This should not have any visible impact, expect potentially improved MarkDown output (https://github.com/ansible-community/antsibull-changelog/pull/174).
- Antsibull-changelog now depends on the new project antsibull-fileutils (https://github.com/ansible-community/antsibull-changelog/pull/176).
- If you are using `argcomplete <https://pypi.org/project/argcomplete/>`__ global completion, you can now tab-complete ``antsibull-changelog`` command lines. See `Activating global completion <https://pypi.org/project/argcomplete/#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`` (https://github.com/ansible-community/antsibull-changelog/pull/173).

=======

Release Summary
---------------

Feature release.

Minor Changes
-------------

- Add a ``reformat`` command that reformats ``changelogs/changelog.yaml`` to the current settings of ``changelogs/config.yaml`` (https://github.com/ansible-community/antsibull-changelog/pull/169).
- Adds a new configuration option ``changelog_sort``. This option allows sorting of changelog entries in ``changelogs/changelog.yaml`` (https://github.com/ansible-community/antsibull-changelog/pull/165).
- Replaces numbers with constants for return codes (https://github.com/ansible-community/antsibull-changelog/issues/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 (https://github.com/ansible-community/antsibull-changelog/issues/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 (https://github.com/ansible-community/antsibull-changelog/pull/167).