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.12.0.tar.gz (73.5 kB view details)

Uploaded Source

Built Distribution

antsibull_changelog-0.12.0-py3-none-any.whl (54.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: antsibull-changelog-0.12.0.tar.gz
  • Upload date:
  • Size: 73.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.6 Linux/5.12.14-arch1-1

File hashes

Hashes for antsibull-changelog-0.12.0.tar.gz
Algorithm Hash digest
SHA256 075625b4c21c4f49318880fbeae9164bef4e57867d869849493df23ddb92fd3d
MD5 d91f6a011165f3a69f0cc9fad0e3efb2
BLAKE2b-256 7ddac61636d8fc7c3b9ccd4651130022fa1f2e58a496c85dd7cbac06185aa782

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for antsibull_changelog-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b38d5a6fbf5fa5e46b8610d6da6dc3cf7403817513c07387c06ba68526a0c6dd
MD5 071734e2336eebda36010a5b7dad3a50
BLAKE2b-256 16dfd7fff4619eeca4aead2a1ccfe236e4bdd997b1130585071a7e69f3b899d9

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