Changelog tool for Ansible-base and Ansible collections
Project description
antsibull-changelog -- Ansible Changelog Tool
A changelog generator used by Ansible and Ansible collections.
- Using the
antsibull-changelog
CLI tool. - Documentation on the
changelogs/config.yaml
configuration file forantsibull-changelog
. - Documentation on the
changelog.yaml
format.
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 .
.
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 LICENSE for a copy of the license.
Project details
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.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7d93c2a9dfb247228dae45112adc1bb8b5ec3a6e66bb526a78f01f6c2cdbe7c |
|
MD5 | f3aaeb3866fb3ed72ab7c0e786389304 |
|
BLAKE2b-256 | 705c4d3c95b9f8d82b293c86d7f2858aba9815a9ac1a498a27cef929d01a6983 |
Hashes for antsibull_changelog-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 684d3b0659458ce007aaa4b8f2cdf1f8a8b7f5913c7b0f5098476ceaf52543e6 |
|
MD5 | 42852fcedb77c823ce196044a957f2f9 |
|
BLAKE2b-256 | 1d383860139d81845e2edae2e922655b3d51b87fcf1e55a8248f8c7a168c9387 |