Tools for building the Ansible Distribution
Project description
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)
Related projects are antsibull-changelog and antsibull-docs, which are in their own repositories (antsibull-changelog repository, antsibull-docs repository). Currently antsibull-changelog is a dependency of antsibull. Therefore, the scripts contained in it 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) 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 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.
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 depends on the sister antsibull-core and antsibull-changelog projects.
By default, nox will install development versions of these projects from
Github.
If you're hacking on antsibull-core or antsibull-changelog alongside antsibull,
nox will automatically install the projects from ../antsibull-core and
../antsibull-changelog 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 aboveOTHER_ANTSIBULL_MODE=local— install the projects from../antsibull-coreand../antsibull-changelog. Fail if those paths don't exist.OTHER_ANTSIBULL_MODE=git— install the projects from the Github main branchOTHER_ANTSIBULL_MODE=pypi— install the latest version from PyPI
To run specific tests:
nox -e testto only run unit tests;nox -e lintto run all linters;nox -e formattersto runisortandblack;nox -e codeqato runflake8,pylint,reuse lint, andantsibull-changelog lint;nox -e typingto runmypyandpyre.nox -e coverage_releaseto build a test ansible release. This is expensive, so it's not run by default.nox -e check_package_filesto run the generate-package-files integration tests. This is somewhat expensive and thus not run by default.nox -e coverageto display combined coverage results after runningnox -e test coverage_release check_package_files;
Run nox -l to list all test sessions.
To create a more complete local development env:
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.git
cd antsibull
python3 -m venv venv
. ./venv/bin/activate
pip install -e '.[dev]' -e ../antsibull-changelog -e ../antsibull-core
[...]
nox
Creating a new release:
- Run
nox -e bump -- <version> <release_summary_message>. This:- Bumps the package version in
pyproject.toml. - 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 <version>' <version>. - Runs
hatch build --cleanto build an sdist and wheel indist/and clean up any old artifacts in that directory.
- Bumps the package version in
- Run
git pushto the appropriate remotes. - Once CI passes on GitHub, run
nox -e publish. This:- Runs
hatch publishto publish the sdist and wheel generated during step 1 to PyPI; - Bumps the version to
<version>.post0; - Adds the changed file to git and runs
git commit -m 'Post-release version bump.';
- Runs
- Run
git push --follow-tagsto the appropriate remotes and create a GitHub release.
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-0.59.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 43ec422b418bb1bb3675849e80c354912b34ad821ebef3f999507283ca9ff65b |
|
| MD5 | a59ca8dcfc3fca9ffb08d8a5cd6b00ad |
|
| BLAKE2b-256 | 11fd76cddb1dd1736b16f66f6b9fe84da82639e71c1392212905b7ef38d4fc99 |
