antsibull-changelog 0.13.0

Changelog tool for Ansible-base and Ansible collections

antsibull-changelog -- Ansible Changelog Tool

A changelog generator used by ansible-core and Ansible collections.

• Using the antsibull-changelog CLI tool for collections.
• Using the antsibull-changelog CLI tool for other projects.
• Documentation on the changelogs/config.yaml configuration file for antsibull-changelog.
• Documentation on the changelog.yaml format.

antsibull-changelog is covered by the Ansible Code of Conduct.

Installation

It can be installed with pip:

pip install antsibull-changelog

For more information, see the documentation.

Using directly from git clone

Scripts are created by poetry at build time. So if you want to run from a checkout, you'll have to run them under poetry:

python3 -m pip install poetry
poetry install  # Installs dependencies into a virtualenv
poetry run antsibull-changelog --help

If you want to create a new release:

poetry build
poetry publish  # Uploads to pypi.  Be sure you really want to do this

Note: When installing a package published by poetry, it is best to use pip >= 19.0. Installing with pip-18.1 and below could create scripts which use pkg_resources which can slow down startup time (in some environments by quite a large amount).

If you prefer to work with pip install -e, you can use dephell to create a setup.py file from pyproject.toml:

dephell deps convert --from-path pyproject.toml --from-format poetry --to-path setup.py --to-format setuppy

Then you can install antsibull-changelog with pip install -e ..

Build a release

First update the version entry in pyproject.toml. Then generate the changelog:

antsibull-changelog release --version <version-number>

Then build the build artefact:

poetry build

Finally, publish to PyPi:

poetry publish

Then tag the current state with the release version and push the tag to the repository.

License

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 LICENSE for a copy of the license.