Changelog tool for Ansible-base and Ansible collections
A changelog generator used by ansible-core and Ansible collections.
antsibull-changelog
CLI tool for collections.antsibull-changelog
CLI tool for other projects.changelogs/config.yaml
configuration file for antsibull-changelog
.changelog.yaml
format.antsibull-changelog is covered by the Ansible Code of Conduct.
It can be installed with pip:
pip install antsibull-changelog
For python projects, antsibull-changelog release
can retrieve the current
version from pyproject.toml
.
You can install the project with
pip install antsibull-changelog[toml]
to pull in the necessary toml parser for this feature.
The toml
extra is always available, but it is noop on Python >= 3.11,
as tomllib
is part of the standard library.
For more information, see the documentation.
Install and run nox
to run all tests. That's it for simple contributions!
nox
will create virtual environments in .nox
inside the checked out project
and install the requirements needed to run the tests there.
To run specific tests:
nox -e test
to only run unit tests;nox -e integration
to only run integration tests; this runs
antsibull-changelog lint
against antsibull-changelog and community.general
(after cloning its repository) and records coverage data.nox -e coverage
to display combined coverage results after running nox -e test integration
;nox -e lint
to run all linters and formatters at once;nox -e formatters
to run isort
and black
;nox -e codeqa
to run flake8
, pylint
, reuse lint
, and antsibull-changelog lint
;nox -e typing
to run mypy
and pyre
nox -e bump -- <version> <release_summary_message>
. This:
pyproject.toml
.changelogs/fragments/<version>.yml
with a release_summary
section.antsibull-changelog release
and adds the changed files to git.Release <version>.
and runs git tag -a -m 'antsibull-changelog <version>' <version>
.hatch build --clean
.git push
to the appropriate remotes.nox -e publish
. This:
hatch publish
;<version>.post0
;git commit -m 'Post-release version bump.'
;git push --follow-tags
to the appropriate remotes and create a GitHub release.Unless otherwise noted in the code, it is licensed under the terms of the GNU General Public License v3 or, at your option, later. See LICENSES/GPL-3.0-or-later.txt for a copy of the license.
The repository follows the REUSE Specification for declaring copyright and
licensing information. The only exception are changelog fragments in changelog/fragments/
.