Changelog tool for Ansible-core and Ansible collections
Project description
antsibull-changelog -- Ansible Changelog Tool
A changelog generator used by ansible-core and Ansible collections.
- Using the
antsibull-changelogCLI tool for collections. - Using the
antsibull-changelogCLI tool for other projects. - Documentation on the
changelogs/config.yamlconfiguration file forantsibull-changelog. - Documentation on the
changelog.yamlformat.
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:
nox -e testto only run unit tests;nox -e integrationto only run integration tests; this runsantsibull-changelog lintagainst antsibull-changelog and community.general (after cloning its repository) and records coverage data.nox -e coverageto display combined coverage results after runningnox -e test integration;nox -e lintto run all linters and formatters at once;nox -e formattersto runisortandblack;nox -e codeqato runflake8,pylint,reuse lint, andantsibull-changelog lint;nox -e typingto runmypyandpyre
Creating a new release:
- Run
nox -e bump -- <version> <release_summary_message>. This:- Bumps the package version in
src/antsibull_changelog/__init__.py. - Creates
changelogs/fragments/<version>.ymlwith arelease_summarysection. - Runs
antsibull-changelog releaseand adds the changed files to git. - Commits with message
Release <version>.and runsgit tag -a -m 'antsibull-changelog <version>' <version>. - Runs
hatch build --clean.
- Bumps the package version in
- Run
git pushto the appropriate remotes. - 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.';
- Runs
- Run
git push --follow-tagsto 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/.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for antsibull_changelog-0.27.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bc3ccce85f1cecc841c8493cf360453243d602f08b30823f378502b7c24031de |
|
| MD5 | 7841638199219562f46169871b9fbdd3 |
|
| BLAKE2b-256 | e249bcfbd69a7a50210570bec09385d7be731c8516b23b80c11b56ffe9645669 |
Hashes for antsibull_changelog-0.27.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f03a45d547ffcdd8fdf9cad2d8e91ee61dfaaef1ee226a35a866104a901ee5e8 |
|
| MD5 | 7ac2e00ccb21c4adb04e08f0250170a9 |
|
| BLAKE2b-256 | 6c86f3b6b268b9e04d391fb38eb5c321aca1cb9cab919cfd43c06d67726ff230 |
