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

Uploaded Source

Built Distribution

antsibull_changelog-0.23.0-py3-none-any.whl (61.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for antsibull_changelog-0.23.0.tar.gz
Algorithm Hash digest
SHA256 521985407e1aa2aef1dbfb2b87275cd6f03ea9a96c0c704e9f9cb04141f90e0b
MD5 faa84f10843f216d307996b4843dbdf9
BLAKE2b-256 142bb09a920ffe797628106c89a8a7d83fadb93dc7fbebd18430f956bec88928

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for antsibull_changelog-0.23.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e9c3425fe6ef8e495aec19705be4af826612f921bdc8dd6dc54d15f70532065f
MD5 5c337ee5c54c9a337ddeb8d8df117847
BLAKE2b-256 b0913b69a3932ba6873a3394711fba9bdf5c3a65e194c866215f9499bf5548b4

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