Brambox build repository

This repository is responsible for building the brambox pip wheels and uploading them to PyPi.
It uses the cibuildwheel package to generate wheels through Github Actions.

Usage

Whenever there is a new brambox version, pull it in the brambox submodule with:

git submodule update
cd brambox
git fetch
git checkout <tag name>

Push these new changes to this repository, which will try to generate wheels for it and upload them to the PyPi test servers and try to install the new package on various different platforms.

If everything seems in order, create a new tag on this repository and push it. This will rebuild the wheels and actually push them to PyPi.

git tag 'vX.Y.Z'
git push --tags

Multiple Test builds

The CI/CD pipeline tries to build, upload and install wheels with the Test PyPi repositories when pushing to master. This allows to make sure everything works before actually pushing a release.

One issue you can expect, is if building and uploading works, but there is an issue installing the wheels in a new environment. Because PyPi does not allow overriding versions, we need to come up with an alternative solution. Our solution is to always build X.Y.Z.devA builds on test-pypi, and simply increase the dev number each time we need to push a new build of a specific version. Because we never push actual releases to test-pypi, this approach works.

In order to increase the dev counter, you can modify the PYPI_TEST_DEV variable in .github/workflows/wheels.yml.