voraus Pipeline Utils

voraus-pipeline-utils provides a single vpu command that wraps the CI/CD building blocks used across voraus robotik projects (JFrog CLI setup, package publishing, Docker builds, and documentation uploads) behind one layered configuration.

Installation

Install voraus-pipeline-utils into your environment:

uv add --dev voraus-pipeline-utils

# or with pip
pip install voraus-pipeline-utils

Usage

# List every command group.
vpu --help

# Print the installed version.
vpu --version

See the documentation for a guided introduction. Start with the Concepts page if Artifactory is new to you, then follow the how-to guide for your CI system.

Contributing

Building the documentation

The documentation is a Docusaurus site under docs/, built on the shared @voraus/docusaurus-theme. Three of its pages (the CLI reference, the license compliance page and the copy-pasteable snippets) are generated from this repository and are not checked in.

# What CI builds, generated pages included.
uv run tox run -e docs

# Writing, with hot reload. Run the line above once first.
npm --prefix docs start

Running the docker integration tests locally

The tests under tests/integration/docker_build/ invoke a real docker build and only run on Linux hosts that have the docker CLI available. To also run the multi-platform build test locally, your machine needs (one-time setup):

1. QEMU / binfmt_misc for emulating non-native architectures (for cross-arch builds on x86):

   docker run --privileged --rm tonistiigi/binfmt --install all
   

   On Arch Linux you can also install qemu-user-static-binfmt directly.

2. A persistent buildx builder named multiarch using the docker-container driver:

   docker buildx inspect multiarch >/dev/null 2>&1 \
     || docker buildx create --name multiarch --driver docker-container --bootstrap
   

   The test targets this builder explicitly via --builder multiarch and writes the resulting multi-arch image to an OCI tarball (--output type=oci,dest=...) for inspection, because the docker daemon cannot load multi-platform images directly. On CI, the workflow creates the same-named builder automatically.