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 REUSE status

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

antsibull-changelog is covered by the Ansible Code of Conduct.

Community

Need help or want to discuss the project? See our Community guide to learn how to join the conversation!

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.


antsibull-changelog depends on the sister antsibull-docutils and antsibull-fileutils projects. By default, nox will install a development version of these projects from Github. If you're hacking on antsibull-docutils and/or antsibull-fileutils alongside antsibull-changelog, nox will automatically install these projects from ../antsibull-docutils and ../antsibull-fileutils when running tests if those paths exist. You can change this behavior through the OTHER_ANTSIBULL_MODE env var:

  • OTHER_ANTSIBULL_MODE=auto — the default behavior described above
  • OTHER_ANTSIBULL_MODE=local — install the projects from ../antsibull-docutils and ../antsibull-fileutils. Fail if those paths don't exist.
  • OTHER_ANTSIBULL_MODE=git — install the projects from the Github main branch
  • OTHER_ANTSIBULL_MODE=pypi — install the latest versions from PyPI

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.

Creating a new release:

  1. Run nox -e bump -- <version> <release_summary_message>. This:
    • Bumps the package version in src/antsibull_changelog/__init__.py.
    • 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.31.1.tar.gz (127.8 kB view details)

Uploaded Source

Built Distribution

antsibull_changelog-0.31.1-py3-none-any.whl (74.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for antsibull_changelog-0.31.1.tar.gz
Algorithm Hash digest
SHA256 e76fcc49969c29ae7b8615e7ea2b4ac275a19ff3afbf3d665f1457ab12493f84
MD5 2b30fd86aa09ec919b29b2df53834303
BLAKE2b-256 c03a8c884a89a6b1594275183e219ef1fd0f57851a6244f8127567636163e8a9

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for antsibull_changelog-0.31.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4b51878ee037199e42e5212b53122e4a4ccc997a783bb73496f41c7238c452e7
MD5 048002a283acc9986c0acb6592af6647
BLAKE2b-256 22270a4f961f35294bb05adaae9603e900bf29ccf4fc08aed228ac59a790125b

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