Skip to main content

Changelog tool for Ansible-base and Ansible collections

Project description

antsibull-changelog -- Ansible Changelog Tool

Python linting badge Python testing badge Codecov badge

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

antsibull-changelog-0.14.0.tar.gz (74.2 kB view details)

Uploaded Source

Built Distribution

antsibull_changelog-0.14.0-py3-none-any.whl (54.9 kB view details)

Uploaded Python 3

File details

Details for the file antsibull-changelog-0.14.0.tar.gz.

File metadata

  • Download URL: antsibull-changelog-0.14.0.tar.gz
  • Upload date:
  • Size: 74.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.2 Linux/5.16.15-arch1-1

File hashes

Hashes for antsibull-changelog-0.14.0.tar.gz
Algorithm Hash digest
SHA256 6924568508acc3c4e51ffb4cf16352d5871532b52eccf51d7a5610141695f30d
MD5 b9669ab269522917b4b2b810dff54745
BLAKE2b-256 73c9b36bbf87a2c36a6c44145037e8dbf6afa7225487fe0565e77210aa370ac5

See more details on using hashes here.

Provenance

File details

Details for the file antsibull_changelog-0.14.0-py3-none-any.whl.

File metadata

File hashes

Hashes for antsibull_changelog-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b77ffbe9b33b8b939f8ea6010252af1ba72532c178426d9471d9403d712519d
MD5 781e1537c530f6bd11f4d017f2f6375b
BLAKE2b-256 0b577eb481e1662a247ac4e01274c4e9b72a4588716be865c1487dc309e2b1eb

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page