Tools for building the Ansible Distribution
antsibull -- Ansible Build Scripts
Tooling for building various things related to Ansible
Scripts that are here:
- antsibull-build - Builds Ansible-2.10+ from component collections (docs)
- antsibull-lint - Soon to be deprecated; collection docs linting functionality is now part of antsibull-docs, and
changelogs/changelog.yamlvalidation functionality is now part of antsibull-changelog.
This also includes a Sphinx extension
sphinx_antsibull_ext which provides a minimal CSS file to render the output of
Related projects are antsibull-changelog and antsibull-docs, which are in their own repositories (antsibull-changelog repository, antsibull-docs repository). Currently both are dependencies of antsibull. Therefore, the scripts contained in them will be available as well when installing antsibull.
You can find a list of changes in the Antsibull changelog.
Unless otherwise noted in the code, it is licensed under the terms of the GNU General Public License v3 or, at your option, later.
antsibull is covered by the Ansible Code of Conduct.
Versioning and compatibility
From version 0.1.0 on, antsibull sticks to semantic versioning and aims at providing no backwards compatibility breaking changes to the command line API (antsibull and antsibull-lint) during a major release cycle. We might make exceptions from this in case of security fixes for vulnerabilities that are severe enough.
We explicitly exclude code compatibility. antsibull is not supposed to be used as a library. The only exception are potential dependencies with other antsibull projects (currently, none). If you want to use a certain part of antsibull-docs as a library, please create an issue so we can discuss whether we add a stable interface for parts of the Python code. We do not promise that this will actually happen though.
Running from source
Please note that to run antsibull from source, you need to install some related projects adjacent to the antsibull checkout. More precisely, assuming you checked out the antsibull repository in a directory
./antsibull/, you need to check out the following projects in the following locations:
- antsibull-changelog needs to be checked out in
- antsibull-core needs to be checked out in
- antsibull-docs needs to be checked out in
This can be done as follows:
git clone https://github.com/ansible-community/antsibull-changelog.git git clone https://github.com/ansible-community/antsibull-core.git git clone https://github.com/ansible-community/antsibull-docs.git git clone https://github.com/ansible-community/antsibull.git cd antsibull
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-build --help
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).
Creating a new release:
If you want to create a new release::
vim pyproject.toml # Make sure the correct version number is used vim changelogs/fragment/$VERSION_NUMBER.yml # create 'release_summary:' fragment antsibull-changelog release --version $VERSION_NUMBER git add CHANGELOG.rst changelogs git commit -m "Release $VERSION_NUMBER." poetry build poetry publish # Uploads to pypi. Be sure you really want to do this git tag $VERSION_NUMBER git push --tags vim pyproject.toml # Bump the version number to X.Y.Z.post0 git commit -m 'Update the version number for the next release' pyproject.toml git push
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for antsibull-0.48.0-py3-none-any.whl