Topics
Bugfix release for ansible-core.
Feature release.
- Add
--strictparameter to thelint-changelog-yamlsubcommand 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).
- 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).
Feature release.
- Allow to configure the used VCS in
changelogs/config.yml. Valid choices arenone(default),git, orauto. If set togit, orautodetects 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-changelogcommand lines. See Activating global completion in the argcomplete README for how to enable tab completion globally. This will also tab-complete Ansible commands such asansible-playbookandansible-test(#173).
Feature release.
- Add a
reformatcommand that reformatschangelogs/changelog.yamlto the current settings ofchangelogs/config.yaml(#169). - Adds a new configuration option
changelog_sort. This option allows sorting of changelog entries inchangelogs/changelog.yaml(#165). - Replaces numbers with constants for return codes (#77).
- Removes support for the deprecated classic changelog format.
changes_formatmust now be present and set tocombinedfor ansible-core usage, and the valueclassicis no longer allowed (#137).
- Remove Python version check that was checking for Python >= 3.6 (instead of >= 3.9). This check is not really necessary since
pyproject.tomldeclaresrequires-python, and old enough Python versions where pip does not know aboutrequires-pythonwill not load antsibull-changelog due to syntax errors anyway (#167).
Feature release.
- There is now an option
changelog_nice_yamlto prepend the YAML document start marker---to the header of thechangelogs/changelog.yamlfile, and to increases indentation level on list items. This makes the file pass ansible-lint (#91, #152, #160).
Feature release.
- Adds period where needed at end of new plugin short descriptions. Controlled by the
add_plugin_periodoption in the config file (#87, #162).
Feature release.
- The Markdown output format is now compatible with python-markdown and mkdocs, as long as the pymdownx.escapeall extension is enabled (#153).
Bugfix and feature release.
- Add
--versionflag to print package version and exit (#147).
- When multiple output formats are defined and
antsibull-changelog generateis used with both--outputand--output-format, an error was displayed that--output-formatmust be specified (#149, #151).
Feature release which now allows to output MarkDown.
- Allow automatically retrieving package version for hatch projects with the
hatch versioncommand (#141). - Allow to render changelogs as MarkDown. The output formats written can be controlled with the
output_formatsoption in the config file (#139). - Officially support Python 3.12 (#134).
- Some code in
antsibull_changelog.changelog_entryhas been deprecated, and theantsibull_changelog.rstmodule 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).
Feature release.
- Allow to generate changelog for a specific version (#130).
- Allow to generate only the last entry without preamble with the
generatecommand (#131). - Allow to write
generateoutput to a user-provided file (#131).
New feature release
- Add
antsibull-changelog-lintandantsibull-changelog-lint-changelog-yamlpre-commit.com hooks (#125). - Add
tomlextra to pull in a toml parser to use to guess the version based onpyproject.toml(#126).
Maintenance release with a deprecation.
- Support for
classicchangelogs is deprecated and will be removed soon. If you need to build changelogs for Ansible 2.9 or before, please use an older version (#123).
Bugfix and maintenance release using a new build system.
- Change pyproject build backend from
poetry-coretohatchling.pip install antsibullworks exactly the same as before, but some users may be affected depending on how they build/install the project (#109).
- When releasing ansible-core and only one of
--versionand--codenameis supplied, error out instead of ignoring the supplied value (#104, #105).
Feature release.
- Allow to extract other project versions for JavaScript / TypeScript projects from
package.json(#100). - Allow to extract other project versions for Python projects from PEP 621 conformant
pyproject.toml(#100). - Support Python 3.11's
tomllibto loadpyproject.toml(#101, #102). - Use more specific exceptions than
Exceptionfor some cases in internal code (#103).
Maintenance release that drops support for older Python versions.
- Drop support for Python 3.6, 3.7, and 3.8 (#93).
Feature release for ansible-core.
- Only allow a
trivalsection in the ansible-core/ansible-base changelog when explicitly configured (#90).
Feature and bugfix release.
- Allow to extract other project versions for Python poetry projects from
pyproject.toml(#80). - The files in the source repository now follow the REUSE Specification. The only exceptions are changelog fragments in
changelogs/fragments/(#82).
- Mark rstcheck 4.x and 5.x as compatible. Support rstcheck 6.x as well (#81).
Feature release.
- Add
changelogs/changelog.yamlfile format linting subcommand that was previously part of antsibull-lint (#76, ansible-community/antsibull-build#410).
Feature release that will speed up the release process with ansible-core 2.13.
- The internal
changelog.yamllinting API allows to usepackaging.version.Versionfor version numbers instead of semantic versioning (#73). - Use the new
--metadata-dumpoption for ansible-core 2.13+ to quickly dump and extract all module/pluginversion_addedvalues for the collection (#72).
This release makes changelog building more reliable.
- Fix issues with module namespaces when symlinks appear in the path to the temp directory (#68, #69).
- Stop mentioning
galaxy.yamlinstead ofgalaxy.ymlin some error messages (#66).
New feature release which supports other projects than ansible-core and Ansible collections.
- Support changelogs for other projects than ansible-core/-base and Ansible collections (#60).
- Fix prerelease collapsing when
use_semantic_versioningis set totruefor ansible-core.
- When using ansible-core 2.11 or newer, will now detect new roles with argument spec. We only consider the
mainentrypoint of roles.
- When subdirectories of
modulesare used in ansible-base/ansible-core, the wrong module name was passed toansible-docwhen--use-ansible-docwas not used.
- The new
--cummulative-releaseoption forantsibull-changelog releaseallows to add all plugins and objects to a release since whoseversion_addedis 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 ofcommunity.generaland similarly organized collections. - Will now print a warning when a release is made where the no
prelude_section_namesection (default:release_summary) appears.
- Make sure that the plugin caching inside ansible-base/-core works without
--use-ansible-doc.
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
testandfilterplugins, and forplaybookandroleobjects, which are not yet automatically detected and mentioned inchangelogs/changelog.yamlor 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 serverFor every entry, a list of plugins (section
add plugin.xxx) or objects (sectionadd object.xxx) of the given type (filter,testfor plugins,playbook,rolefor 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 theshort_descriptionfield of theDOCUMENTATIONblock of modules and documentable plugins.
- Add
--update-existingoption forantsibull-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.
- The new option
prevent_known_fragmentswith default value being the value ofkeep_fragmentsallows to control whether fragments with names that already appeared in the past are ignored or not. The new behavior happens ifkeep_fragments=false, and is less surprising to users (see #46). Changelogs withkeep_fragments=true, like the ansible-base/ansible-core changelog, are not affected.
- Fixed error on generating changelogs when using the trivial section.
- Allow to not save a changelog on release when using API.
- Allow to sanitize changelog data on load/save. This means that unknown information will be removed, and bad information will be stripped. This will be enabled in newly created changelog configs, but is disabled for backwards compatibility.
- A new config option,
ignore_other_fragment_extensionsallows for configuring whether only.yamland.ymlfiles are used (as mandated by theansible-test sanity --test changelogtest). The default value for existing configurations isfalse, and for new configurationstrue. - Allow to use semantic versioning also for Ansible-base with the
use_semantic_versioningconfiguration setting. - Refactoring changelog generation code to provide all preludes (release summaries) in changelog entries, and provide generic functionality to extract a grouped list of versions. These changes are mainly for the antsibull project.
- New changelog configurations place the
CHANGELOG.rstfile by default in the top-level directory, and not inchangelogs/. - The config option
archive_path_templateallows to move fragments into an archive directory whenkeep_fragmentsis set tofalse. - The option
use_fqcn(set totruein new configurations) allows to use FQCN for new plugins and modules.
- The internal changelog generator code got more flexible to help antsibull generate Ansible porting guides.
- Allow to enable or disable flatmapping via
config.yaml.
- Fix bad module namespace detection when collection was symlinked into Ansible's collection search path. This also allows to add releases to collections which are not installed in a way that Ansible finds them.
- Do not fail when
changelogs/fragmentsdoes not exist. Simply assume there are no fragments in that case. - Improve behavior when
changelogs/config.yamlis not a dictionary, or does not containsections. - Improve error message when
--is-collectionis specified andchangelogs/config.yamlcannot be found, or when thelintsubcommand is used.
- Allow to pass path to ansible-doc binary via
--ansible-doc-bin. - Changelog generator can be ran via
python -m antsibull_changelog. - Use
ansible-docinstead of/path/to/checkout/bin/ansible-docwhen being run in ansible-base checkouts.
- Allow to enumerate plugins/modules with ansible-doc by specifying
--use-ansible-doc.
- Added more testing.
- Fix internal API for ACD changelog generation (pruning and concatenation of changelogs).
- Improve error handling.
- Improve reStructuredText creation when new modules with and without namespace exist at the same time.
- Title generation improved (remove superfluous space).
- Use PyYAML C loader/dumper if available.
lintsubcommand no longer requires specification whether it is run inside a collection or not (if usual indicators are absent).
Initial release as antsibull-changelog. The Ansible Changelog Tool has originally been developed by @mattclay in the ansible/ansible repository for Ansible itself. It has been extended in felixfontein/ansible-changelog and ansible-community/antsibull to work with collections, until it was moved to its current location ansible-community/antsibull-changelog.