search

ansible-community / antsibull-changelog

Changelog generator for ansible, ansible-base, and collections.
https://ansible.readthedocs.io/projects/antsibull-changelog/
GNU General Public License v3.0
36 stars 28 forks source link

Remove support for classic changelog format #137

Closed felixfontein closed 3 months ago

felixfontein commented 10 months ago

That format is used by Ansible 2.9 (and nothing else to my knowledge). It has been deprecated in 0.21.0 (released on 2023-06-27).

If a new relase of Ansible 2.9 should be done, an older version of antsibull-changelog still supporting that format can be used. IMO there's no need to carry around the extra complexity.

samccann commented 3 months ago

@felixfontein - I was poking away at this one and removing all classic support, but then I noticed this in the docs about the changes_format:

Note that support for `classic` is **DEPRECATED** and will be removed in
a future release. The field will from then on be required.

So does that mean we need to keep that parameter around even though it can only ever be combined once classic support is removed? Or can we just get rid of it entirely?

felixfontein commented 3 months ago

@samccann that parameter should stay around for some time, and make the program fail if set to anything else than combined. That ensures that new versions of antsibull-changelog aren't accidentally used with projects using the old format that it no longer supports.