Antsibull-changelog

=======

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

Feature release that will speed up the release process with ansible-core 2.13.

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

- The internal ``changelog.yaml`` linting API allows to use ``packaging.version.Version`` for version numbers instead of semantic versioning (https://github.com/ansible-community/antsibull-changelog/pull/73).
- Use the new ``--metadata-dump`` option for ansible-core 2.13+ to quickly dump and extract all module/plugin ``version_added`` values for the collection (https://github.com/ansible-community/antsibull-changelog/pull/72).

=======

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

This release makes changelog building more reliable.

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

- Always lint fragments before releasing (https://github.com/ansible-community/antsibull-changelog/issues/65, https://github.com/ansible-community/antsibull-changelog/pull/67).

Bugfixes
--------

- Fix issues with module namespaces when symlinks appear in the path to the temp directory (https://github.com/ansible-community/antsibull-changelog/issues/68, https://github.com/ansible-community/antsibull-changelog/pull/69).
- Stop mentioning ``galaxy.yaml`` instead of ``galaxy.yml`` in some error messages (https://github.com/ansible-community/antsibull-changelog/pull/66).

=======

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

New feature release which supports other projects than ansible-core and Ansible collections.

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

- Support changelogs for other projects than ansible-core/-base and Ansible collections (https://github.com/ansible-community/antsibull-changelog/pull/60).

Bugfixes
--------

- Fix prerelease collapsing when ``use_semantic_versioning`` is set to ``true`` for ansible-core.

=======

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

- When using ansible-core 2.11 or newer, will now detect new roles with argument spec. We only consider the ``main`` entrypoint of roles.

Bugfixes
--------

- When subdirectories of ``modules`` are used in ansible-base/ansible-core, the wrong module name was passed to ``ansible-doc`` when ``--use-ansible-doc`` was not used.

=======

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

- The new ``--cummulative-release`` option for ``antsibull-changelog release`` allows to add all plugins and objects to a release since whose ``version_added`` is later than the previous release version (or ancestor if there was no previous release), and at latest the current release version. This is needed for major releases of ``community.general`` and similarly organized collections.
- Will now print a warning when a release is made where the no ``prelude_section_name`` section (default: ``release_summary``) appears.

Bugfixes
--------

- Make sure that the plugin caching inside ansible-base/-core works without ``--use-ansible-doc``.

======

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

- Add support for reporting new playbooks and roles in collections.
- Add support for special changelog fragment sections which add new plugins and/or objects to the changelog for this version. This is mainly useful for ``test`` and ``filter`` plugins, and for ``playbook`` and ``role`` objects, which are not yet automatically detected and mentioned in ``changelogs/changelog.yaml`` or the generated RST changelog.

The format of these sections and their content is as follows::

---
add plugin.filter:
- name: to_time_unit
description: Converts a time expression to a given unit
- name: to_seconds
description: Converts a time expression to seconds
add object.role:
- name: nginx
description: The most awesome nginx installation role ever
add object.playbook:
- name: wipe_server
description: Totally wipes a server

For every entry, a list of plugins (section ``add plugin.xxx``) or objects (section ``add object.xxx``) of the given type (``filter``, ``test`` for plugins, ``playbook``, ``role`` for objects) will be added. Every plugin or object has a short name as well as a short description. These fields correspond to the module/plugin name and the ``short_description`` field of the ``DOCUMENTATION`` block of modules and documentable plugins.

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

- Add ``--update-existing`` option for ``antsibull-changelog release``, which allows to update the current release's release date and (if relevant) codename instead of simply reporting that the release already exists.

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

- The new option ``prevent_known_fragments`` with default value being the value of ``keep_fragments`` allows to control whether fragments with names that already appeared in the past are ignored or not. The new behavior happens if ``keep_fragments=false``, and is less surprising to users (see https://github.com/ansible-community/antsibull-changelog/issues/46). Changelogs with ``keep_fragments=true``, like the ansible-base/ansible-core changelog, are not affected.