Skip to main content

Changelog tool for Ansible-core and Ansible collections

Project description

antsibull-changelog -- Ansible Changelog Tool

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

Development

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:

  1. nox -e test to only run unit tests;
  2. 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.
  3. nox -e coverage to display combined coverage results after running nox -e test integration;
  4. nox -e lint to run all linters and formatters at once;
  5. nox -e formatters to run isort and black;
  6. nox -e codeqa to run flake8, pylint, reuse lint, and antsibull-changelog lint;
  7. nox -e typing to run mypy and pyre

Creating a new release:

  1. Run nox -e bump -- <version> <release_summary_message>. This:
    • Bumps the package version in pyproject.toml.
    • Creates changelogs/fragments/<version>.yml with a release_summary section.
    • Runs antsibull-changelog release and adds the changed files to git.
    • Commits with message Release <version>. and runs git tag -a -m 'antsibull-changelog <version>' <version>.
    • Runs hatch build --clean.
  2. Run git push to the appropriate remotes.
  3. Once CI passes on GitHub, run nox -e publish. This:
    • Runs hatch publish;
    • Bumps the version to <version>.post0;
    • Adds the changed file to git and run git commit -m 'Post-release version bump.';
  4. Run git push --follow-tags to the appropriate remotes and create a GitHub release.

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

Uploaded Source

Built Distribution

antsibull_changelog-0.26.0-py3-none-any.whl (81.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: antsibull_changelog-0.26.0.tar.gz
  • Upload date:
  • Size: 129.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.0

File hashes

Hashes for antsibull_changelog-0.26.0.tar.gz
Algorithm Hash digest
SHA256 8060c438d9fb5a1025a1e98d4de0ce8d897be6e0c21014216151b93f4e4891ff
MD5 deffdc8ed2fc0e25a481dbbde7d3172c
BLAKE2b-256 0700738190db8ec26856e55f6925d9a88ee8b2744b3d3d36c549c20b76ad5e5e

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for antsibull_changelog-0.26.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0a6aa5327790e89a686872fd452a9c31be288a3cb2deb9cc23eb3fc5ea7f0a19
MD5 ad7737feecfe6b9563956845e4467da1
BLAKE2b-256 bb6123ccedb18b2ae527a01aefdc507eacdb2cdaec5e15f38a5081f15edb2b58

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