From 6ae8fd4fb6c8e5906ecea5f2d2bf2cf65c89f805 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sat, 19 Oct 2024 21:20:08 +0200 Subject: [PATCH] Release 0.31.0. --- CHANGELOG.md | 199 +++++++++++--------- CHANGELOG.rst | 21 +++ changelogs/changelog.yaml | 23 +++ changelogs/fragments/0.31.0.yml | 1 - changelogs/fragments/179-cleanup.yml | 7 - changelogs/fragments/181-extra-data.yml | 3 - changelogs/fragments/182-strict-linting.yml | 2 - changelogs/fragments/python-3.13.yml | 2 - 8 files changed, 156 insertions(+), 102 deletions(-) delete mode 100644 changelogs/fragments/0.31.0.yml delete mode 100644 changelogs/fragments/179-cleanup.yml delete mode 100644 changelogs/fragments/181-extra-data.yml delete mode 100644 changelogs/fragments/182-strict-linting.yml delete mode 100644 changelogs/fragments/python-3.13.yml diff --git a/CHANGELOG.md b/CHANGELOG.md index 217b2b93..cf2f5824 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,107 +2,111 @@ **Topics** -- v0\.30\.0 +- v0\.31\.0 - Release Summary - Minor Changes -- v0\.29\.0 + - Breaking Changes / Porting Guide +- v0\.30\.0 - Release Summary - Minor Changes +- v0\.29\.0 + - Release Summary + - Minor Changes - Removed Features \(previously deprecated\) - Bugfixes - v0\.28\.0 - - Release Summary - - Minor Changes -- v0\.27\.0 - Release Summary - Minor Changes -- v0\.26\.0 +- v0\.27\.0 - Release Summary - Minor Changes -- v0\.25\.0 +- v0\.26\.0 - Release Summary - Minor Changes - - Bugfixes -- v0\.24\.0 +- v0\.25\.0 - Release Summary - Minor Changes - - Deprecated Features -- v0\.23\.0 + - Bugfixes +- v0\.24\.0 - Release Summary - Minor Changes -- v0\.22\.0 + - Deprecated Features +- v0\.23\.0 - Release Summary - Minor Changes -- v0\.21\.0 +- v0\.22\.0 - Release Summary + - Minor Changes +- v0\.21\.0 + - Release Summary - Deprecated Features - v0\.20\.0 - - Release Summary + - Release Summary - Major Changes - Bugfixes - v0\.19\.0 - - Release Summary - - Minor Changes -- v0\.18\.0 - Release Summary - - Breaking Changes / Porting Guide -- v0\.17\.0 - - Release Summary - Minor Changes -- v0\.16\.0 +- v0\.18\.0 + - Release Summary + - Breaking Changes / Porting Guide +- v0\.17\.0 - Release Summary - Minor Changes - - Bugfixes -- v0\.15\.0 +- v0\.16\.0 - Release Summary - Minor Changes -- v0\.14\.0 + - Bugfixes +- v0\.15\.0 - Release Summary - Minor Changes -- v0\.13\.0 +- v0\.14\.0 - Release Summary - Minor Changes - - Bugfixes -- v0\.12\.0 +- v0\.13\.0 - Release Summary - Minor Changes + - Bugfixes +- v0\.12\.0 + - Release Summary + - Minor Changes - Bugfixes - v0\.11\.0 - - Minor Changes + - Minor Changes - Bugfixes - v0\.10\.0 - - Minor Changes + - Minor Changes - Bugfixes - v0\.9\.0 - Major Changes - - Minor Changes - - Breaking Changes / Porting Guide + - Minor Changes + - Breaking Changes / Porting Guide - v0\.8\.1 - Bugfixes - v0\.8\.0 - - Minor Changes -- v0\.7\.0 - Minor Changes -- v0\.6\.0 +- v0\.7\.0 - Minor Changes -- v0\.5\.0 +- v0\.6\.0 - Minor Changes -- v0\.4\.0 +- v0\.5\.0 - Minor Changes +- v0\.4\.0 + - Minor Changes - Bugfixes - v0\.3\.1 - Bugfixes - v0\.3\.0 - - Minor Changes + - Minor Changes - v0\.2\.1 - Bugfixes - v0\.2\.0 - - Minor Changes + - Minor Changes - v0\.1\.0 - - Release Summary + - Release Summary - -## v0\.30\.0 + +## v0\.31\.0 ### Release Summary @@ -112,6 +116,27 @@ 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](https\://github\.com/ansible\-community/antsibull\-changelog/pull/182)\)\. +* Declare support for Python 3\.13 \([https\://github\.com/ansible\-community/antsibull\-changelog/pull/180](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](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](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](https\://github\.com/ansible\-community/antsibull\-changelog/pull/179)\)\. + + +## v0\.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 \([https\://github\.com/ansible\-community/antsibull\-changelog/issues/172](https\://github\.com/ansible\-community/antsibull\-changelog/issues/172)\, [https\://github\.com/ansible\-community/antsibull\-changelog/pull/175](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](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](https\://github\.com/ansible\-community/antsibull\-changelog/pull/176)\)\. @@ -120,12 +145,12 @@ Feature release\. ## v0\.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 \([https\://github\.com/ansible\-community/antsibull\-changelog/pull/169](https\://github\.com/ansible\-community/antsibull\-changelog/pull/169)\)\. @@ -145,12 +170,12 @@ Feature release\. ## v0\.28\.0 - + ### Release Summary Feature release\. - + ### Minor Changes * There is now an option changelog\_nice\_yaml to prepend the YAML document start @@ -163,12 +188,12 @@ Feature release\. ## v0\.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 \([https\://github\.com/ansible\-community/antsibull\-changelog/issues/87](https\://github\.com/ansible\-community/antsibull\-changelog/issues/87)\, [https\://github\.com/ansible\-community/antsibull\-changelog/pull/162](https\://github\.com/ansible\-community/antsibull\-changelog/pull/162)\)\. @@ -176,12 +201,12 @@ Feature release\. ## v0\.26\.0 - + ### Release Summary Feature release\. - + ### Minor Changes * The Markdown output format is now compatible with [python\-markdown](https\://python\-markdown\.github\.io/) and [mkdocs](https\://www\.mkdocs\.org/)\, as long as the [pymdownx\.escapeall](https\://facelessuser\.github\.io/pymdown\-extensions/extensions/escapeall/) extension is enabled \([https\://github\.com/ansible\-community/antsibull\-changelog/pull/153](https\://github\.com/ansible\-community/antsibull\-changelog/pull/153)\)\. @@ -189,12 +214,12 @@ Feature release\. ## v0\.25\.0 - + ### Release Summary Bugfix and feature release\. - + ### Minor Changes * Add \-\-version flag to print package version and exit \([https\://github\.com/ansible\-community/antsibull\-changelog/pull/147](https\://github\.com/ansible\-community/antsibull\-changelog/pull/147)\)\. @@ -207,12 +232,12 @@ Bugfix and feature release\. ## v0\.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 \([https\://github\.com/ansible\-community/antsibull\-changelog/pull/141](https\://github\.com/ansible\-community/antsibull\-changelog/pull/141)\)\. @@ -227,12 +252,12 @@ Feature release which now allows to output MarkDown\. ## v0\.23\.0 - + ### Release Summary Feature release\. - + ### Minor Changes * Allow to generate changelog for a specific version \([https\://github\.com/ansible\-community/antsibull\-changelog/pull/130](https\://github\.com/ansible\-community/antsibull\-changelog/pull/130)\)\. @@ -242,12 +267,12 @@ Feature release\. ## v0\.22\.0 - + ### Release Summary New feature release - + ### Minor Changes * Add antsibull\-changelog\-lint and antsibull\-changelog\-lint\-changelog\-yaml pre\-commit\.com hooks \([https\://github\.com/ansible\-community/antsibull\-changelog/pull/125](https\://github\.com/ansible\-community/antsibull\-changelog/pull/125)\)\. @@ -256,7 +281,7 @@ New feature release ## v0\.21\.0 - + ### Release Summary Maintenance release with a deprecation\. @@ -269,7 +294,7 @@ Maintenance release with a deprecation\. ## v0\.20\.0 - + ### Release Summary Bugfix and maintenance release using a new build system\. @@ -287,12 +312,12 @@ Bugfix and maintenance release using a new build system\. ## v0\.19\.0 - + ### Release Summary Feature release\. - + ### Minor Changes * Allow to extract other project versions for JavaScript / TypeScript projects from package\.json \([https\://github\.com/ansible\-community/antsibull\-changelog/pull/100](https\://github\.com/ansible\-community/antsibull\-changelog/pull/100)\)\. @@ -303,12 +328,12 @@ Feature release\. ## v0\.18\.0 - + ### Release Summary Maintenance release that drops support for older Python versions\. - + ### Breaking Changes / Porting Guide * Drop support for Python 3\.6\, 3\.7\, and 3\.8 \([https\://github\.com/ansible\-community/antsibull\-changelog/pull/93](https\://github\.com/ansible\-community/antsibull\-changelog/pull/93)\)\. @@ -316,12 +341,12 @@ Maintenance release that drops support for older Python versions\. ## v0\.17\.0 - + ### Release Summary Feature release for ansible\-core\. - + ### Minor Changes * Only allow a trival section in the ansible\-core/ansible\-base changelog when explicitly configured \([https\://github\.com/ansible\-community/antsibull\-changelog/pull/90](https\://github\.com/ansible\-community/antsibull\-changelog/pull/90)\)\. @@ -329,12 +354,12 @@ Feature release for ansible\-core\. ## v0\.16\.0 - + ### Release Summary Feature and bugfix release\. - + ### Minor Changes * Allow to extract other project versions for Python poetry projects from pyproject\.toml \([https\://github\.com/ansible\-community/antsibull\-changelog/pull/80](https\://github\.com/ansible\-community/antsibull\-changelog/pull/80)\)\. @@ -348,12 +373,12 @@ Feature and bugfix release\. ## v0\.15\.0 - + ### Release Summary Feature release\. - + ### Minor Changes * Add changelogs/changelog\.yaml file format linting subcommand that was previously part of antsibull\-lint \([https\://github\.com/ansible\-community/antsibull\-changelog/pull/76](https\://github\.com/ansible\-community/antsibull\-changelog/pull/76)\, [https\://github\.com/ansible\-community/antsibull/issues/410](https\://github\.com/ansible\-community/antsibull/issues/410)\)\. @@ -361,12 +386,12 @@ Feature release\. ## v0\.14\.0 - + ### 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](https\://github\.com/ansible\-community/antsibull\-changelog/pull/73)\)\. @@ -375,12 +400,12 @@ Feature release that will speed up the release process with ansible\-core 2\.13\ ## v0\.13\.0 - + ### 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/issues/65)\, [https\://github\.com/ansible\-community/antsibull\-changelog/pull/67](https\://github\.com/ansible\-community/antsibull\-changelog/pull/67)\)\. @@ -394,12 +419,12 @@ This release makes changelog building more reliable\. ## v0\.12\.0 - + ### 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](https\://github\.com/ansible\-community/antsibull\-changelog/pull/60)\)\. @@ -412,7 +437,7 @@ New feature release which supports other projects than ansible\-core and Ansible ## v0\.11\.0 - + ### 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\. @@ -425,7 +450,7 @@ New feature release which supports other projects than ansible\-core and Ansible ## v0\.10\.0 - + ### 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\. @@ -464,12 +489,12 @@ New feature release which supports other projects than ansible\-core and Ansible 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](https\://github\.com/ansible\-community/antsibull\-changelog/issues/46)\)\. Changelogs with keep\_fragments\=true\, like the ansible\-base/ansible\-core changelog\, are not affected\. @@ -485,7 +510,7 @@ New feature release which supports other projects than ansible\-core and Ansible ## v0\.8\.0 - + ### Minor Changes * Allow to not save a changelog on release when using API\. @@ -494,7 +519,7 @@ New feature release which supports other projects than ansible\-core and Ansible ## v0\.7\.0 - + ### Minor Changes * A new config option\, ignore\_other\_fragment\_extensions allows for configuring whether only \.yaml and \.yml files are used \(as mandated by the ansible\-test sanity \-\-test changelog test\)\. The default value for existing configurations is false\, and for new configurations true\. @@ -504,7 +529,7 @@ New feature release which supports other projects than ansible\-core and Ansible ## v0\.6\.0 - + ### Minor Changes * New changelog configurations place the CHANGELOG\.rst file by default in the top\-level directory\, and not in changelogs/\. @@ -514,7 +539,7 @@ New feature release which supports other projects than ansible\-core and Ansible ## v0\.5\.0 - + ### Minor Changes * The internal changelog generator code got more flexible to help antsibull generate Ansible porting guides\. @@ -522,7 +547,7 @@ New feature release which supports other projects than ansible\-core and Ansible ## v0\.4\.0 - + ### Minor Changes * Allow to enable or disable flatmapping via config\.yaml\. @@ -545,7 +570,7 @@ New feature release which supports other projects than ansible\-core and Ansible ## v0\.3\.0 - + ### Minor Changes * Allow to pass path to ansible\-doc binary via \-\-ansible\-doc\-bin\. @@ -563,7 +588,7 @@ New feature release which supports other projects than ansible\-core and Ansible ## v0\.2\.0 - + ### Minor Changes * Added more testing\. @@ -577,7 +602,7 @@ New feature release which supports other projects than ansible\-core and Ansible ## v0\.1\.0 - + ### Release Summary Initial release as antsibull\-changelog\. The Ansible Changelog Tool has originally been developed by \@mattclay in [the ansible/ansible](https\://github\.com/ansible/ansible/blob/stable\-2\.9/packaging/release/changelogs/changelog\.py) repository for Ansible itself\. It has been extended in [felixfontein/ansible\-changelog](https\://github\.com/felixfontein/ansible\-changelog/) and [ansible\-community/antsibull](https\://github\.com/ansible\-community/antsibull/) to work with collections\, until it was moved to its current location [ansible\-community/antsibull\-changelog](https\://github\.com/ansible\-community/antsibull\-changelog/)\. diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 0c537ec6..5069428d 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,27 @@ Ansible Changelog Tool Release Notes .. contents:: Topics +v0.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 (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). + v0.30.0 ======= diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 4aaf2d2c..3bd8544f 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -461,3 +461,26 @@ releases: - 175-vcs.yml - 176-antsibull-fileutils.yml release_date: '2024-09-09' + 0.31.0: + changes: + breaking_changes: + - 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). + 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).' + release_summary: Feature release. + fragments: + - 0.31.0.yml + - 179-cleanup.yml + - 181-extra-data.yml + - 182-strict-linting.yml + - python-3.13.yml + release_date: '2024-10-19' diff --git a/changelogs/fragments/0.31.0.yml b/changelogs/fragments/0.31.0.yml deleted file mode 100644 index 512efc99..00000000 --- a/changelogs/fragments/0.31.0.yml +++ /dev/null @@ -1 +0,0 @@ -release_summary: Feature release. diff --git a/changelogs/fragments/179-cleanup.yml b/changelogs/fragments/179-cleanup.yml deleted file mode 100644 index fd9cd02a..00000000 --- a/changelogs/fragments/179-cleanup.yml +++ /dev/null @@ -1,7 +0,0 @@ -breaking_changes: - - "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)." diff --git a/changelogs/fragments/181-extra-data.yml b/changelogs/fragments/181-extra-data.yml deleted file mode 100644 index 25014191..00000000 --- a/changelogs/fragments/181-extra-data.yml +++ /dev/null @@ -1,3 +0,0 @@ -minor_changes: - - "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)." diff --git a/changelogs/fragments/182-strict-linting.yml b/changelogs/fragments/182-strict-linting.yml deleted file mode 100644 index dd4c15ff..00000000 --- a/changelogs/fragments/182-strict-linting.yml +++ /dev/null @@ -1,2 +0,0 @@ -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)." diff --git a/changelogs/fragments/python-3.13.yml b/changelogs/fragments/python-3.13.yml deleted file mode 100644 index db520606..00000000 --- a/changelogs/fragments/python-3.13.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - Declare support for Python 3.13 (https://github.com/ansible-community/antsibull-changelog/pull/180).