Skip to main content

Tools for building the Ansible Distribution

Project description

antsibull -- Ansible Build Scripts

Python linting badge Python testing badge Build CSS testing badge dumb PyPI on GH pages badge Codecov badge

Tooling for building various things related to Ansible

Scripts that are here:

  • antsibull-build - Builds Ansible-2.10+ from component collections (docs)
  • antsibull-docs - Extracts documentation from ansible plugins
  • antsibull-lint - Right now only validates changelogs/changelog.yaml files (docs)

This also includes a Sphinx extension sphinx_antsibull_ext which provides a minimal CSS file to render the output of antsibull-docs correctly.

A related project is antsibull-changelog, which is in its own repository.

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).

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.

Using the Sphinx extension

Include it in your Sphinx configuration conf.py::

# Add it to 'extensions':
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'notfound.extension', 'sphinx_antsibull_ext']

Updating the CSS file for the Sphinx extension

The CSS file sphinx_antsibull_ext/antsibull-minimal.css is built from sphinx_antsibull_ext/css/antsibull-minimal.scss using SASS and postcss using autoprefixer and cssnano.

Use the script build.sh in sphinx_antsibull_ext/css/ to build the .css file from the .scss file:

cd sphinx_antsibull_ext/css/
./build-css.sh

For this to work, you need to make sure that sassc and postcss are on your path and that the autoprefixer and nanocss modules are installed:

# Debian:
apt-get install sassc

# PostCSS, autoprefixer and cssnano require nodejs/npm:
npm install -g autoprefixer cssnano postcss postcss-cli

Creating a new release:

If you want to create a new release::

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
git commit -m 'Update the version number for the next release' pyproject.toml
git push

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

antsibull-0.40.2.tar.gz (207.3 kB view details)

Uploaded Source

Built Distribution

antsibull-0.40.2-py3-none-any.whl (218.5 kB view details)

Uploaded Python 3

File details

Details for the file antsibull-0.40.2.tar.gz.

File metadata

  • Download URL: antsibull-0.40.2.tar.gz
  • Upload date:
  • Size: 207.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.1 Linux/5.15.12-arch1-1

File hashes

Hashes for antsibull-0.40.2.tar.gz
Algorithm Hash digest
SHA256 6c8d896d18c77fd0d6faf7331ac1a5bcc5a045878e712768990505da48eefce4
MD5 e4fbac996df080e587f4f7e5678452e5
BLAKE2b-256 74aaf6a1053680b093efdaba602e84bcc24d5c242f267770f51848e5d5634866

See more details on using hashes here.

Provenance

File details

Details for the file antsibull-0.40.2-py3-none-any.whl.

File metadata

  • Download URL: antsibull-0.40.2-py3-none-any.whl
  • Upload date:
  • Size: 218.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.1 Linux/5.15.12-arch1-1

File hashes

Hashes for antsibull-0.40.2-py3-none-any.whl
Algorithm Hash digest
SHA256 df1bee7fedf97a24dc09ade4fd3da6f42cad482ebb1976a3a7300c16122a9373
MD5 5155be2e193561009cac9ca861a95ec6
BLAKE2b-256 001f283f1f16f763450a45fec36b4c3a31566e900b7e21c489bafbaedd61ba95

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