Skip to main content

Changelog tool for Ansible-base and Ansible collections

Project description

antsibull-changelog -- Ansible Changelog Tool

Discuss on Matrix at #community:ansible.com 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

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 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/.

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

Uploaded Source

Built Distribution

antsibull_changelog-0.19.0-py3-none-any.whl (71.9 kB view details)

Uploaded Python 3

File details

Details for the file antsibull_changelog-0.19.0.tar.gz.

File metadata

  • Download URL: antsibull_changelog-0.19.0.tar.gz
  • Upload date:
  • Size: 77.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.10.9 Linux/6.2.2-arch1-1

File hashes

Hashes for antsibull_changelog-0.19.0.tar.gz
Algorithm Hash digest
SHA256 b908e43d4df45ce662a388d131f67ccc3bc12921cc11d2f3ba969a31aef388fd
MD5 83b166ba2933075dcd3edfeb6828458b
BLAKE2b-256 0a95ff7025bb3e89968f6aa1f38b6e077ed072a6e537c25923e8ce075a9431f0

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for antsibull_changelog-0.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 27188a1453e9aa56671d02617eb939375fba9d72186e0c50ee1c348b70abc12b
MD5 be711ce0e131140ece2d98b6f665f71b
BLAKE2b-256 29af2dbdf9e35f709e9c9877540a64046bfc5ad02ebbe1f11f6bebe3b43fcd7c

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