.github/workflows/build.yml
name: Build wheels, optionally deploy to PyPI
on:
workflow_dispatch:
inputs:
confirm_ref:
description: "Confirm chosen branch name to deploy to PyPI (optional):"
default: ""
override_version:
description: "Override version number (optional):"
default: ""
jobs:
# The deploy_test job is part of the test of whether we should deploy to PyPI
# or test.PyPI. The job will succeed if either the confirmation reference is
# empty, 'test' or if the confirmation is the selected branch or tag name.
# It will fail if it is nonempty and does not match. All later jobs depend
# on this job, so that they will be immediately cancelled if the confirmation
# is bad. The dependency is currently necessary (2021-03) because GitHub
# Actions does not have a simpler method of cancelling an entire workflow---
# the normal use-case expects to try and run as much as possible despite one
# or two failures.
deploy_test:
name: Verify PyPI deployment confirmation
runs-on: ubuntu-latest
env:
GITHUB_REF: ${{ github.ref }}
CONFIRM_REF: ${{ github.event.inputs.confirm_ref }}
steps:
- name: Compare confirmation to current reference
shell: bash
run: |
[[ -z $CONFIRM_REF || $GITHUB_REF =~ ^refs/(heads|tags)/$CONFIRM_REF$ || $CONFIRM_REF == "test" ]]
if [[ $CONFIRM_REF == "test" ]]; then
echo "Build and deploy to test.pypi.org."
elif [[ -z $CONFIRM_REF ]]; then
echo "Build only. Nothing will be uploaded to PyPI."
else
echo "Full build and deploy. Wheels and source will be uploaded to PyPI."
fi
build_sdist:
name: Build sdist on Ubuntu
needs: deploy_test
runs-on: ubuntu-latest
env:
OVERRIDE_VERSION: ${{ github.event.inputs.override_version }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
name: Install Python
with:
# For the sdist we should be as conservative as possible with our
# Python version. This should be the lowest supported version. This
# means that no unsupported syntax can sneak through.
python-version: '3.10'
- name: Install pip build
run: |
python -m pip install 'build'
- name: Build sdist tarball
shell: bash
run: |
if [[ ! -z "$OVERRIDE_VERSION" ]]; then echo "$OVERRIDE_VERSION" > VERSION; fi
# The build package is the reference PEP 517 package builder. All
# dependencies are specified by our setup code.
python -m build --sdist .
# Zip files are not part of PEP 517, so we need to make our own.
- name: Create zipfile from tarball
shell: bash
working-directory: dist
run: |
# First assert that there is exactly one tarball, and find its name.
shopt -s failglob
tarball_pattern="*.tar.gz"
tarballs=($tarball_pattern)
[[ ${#tarballs[@]} == 1 ]]
tarball="${tarballs[0]}"
# Get the stem and make the zipfile name.
stem="${tarball%.tar.gz}"
zipfile="${stem}.zip"
# Extract the tarball and rezip it.
tar -xzf "$tarball"
zip "$zipfile" -r "$stem"
rm -r "$stem"
- uses: actions/upload-artifact@v4
with:
name: sdist
path: |
dist/*.tar.gz
dist/*.zip
if-no-files-found: error
build_wheels:
name: Build wheels on ${{ matrix.os }}
needs: deploy_test
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
env:
# Set up wheels matrix. This is CPython 3.10--3.12 for all OS targets.
CIBW_BUILD: "cp3{10,11,12}-*"
# Numpy and SciPy do not supply wheels for i686 or win32 for
# Python 3.10+, so we skip those:
CIBW_SKIP: "*-musllinux* cp3{10,11,12}-manylinux_i686 cp3{10,11,12}-win32"
OVERRIDE_VERSION: ${{ github.event.inputs.override_version }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
name: Install Python
with:
# This is about the build environment, not the released wheel version.
python-version: '3.10'
- name: Install cibuildwheel
run: |
# cibuildwheel does the heavy lifting for us. Originally tested on
# 2.11.3, but should be fine at least up to any minor new release.
python -m pip install 'cibuildwheel==2.11.*'
- name: Build wheels
shell: bash
run: |
# If the version override was specified, then write it the VERSION
# file with it.
if [[ ! -z "$OVERRIDE_VERSION" ]]; then echo "$OVERRIDE_VERSION" > VERSION; fi
python -m cibuildwheel --output-dir wheelhouse
- uses: actions/upload-artifact@v4
with:
name: wheels
path: ./wheelhouse/*.whl
deploy:
name: "Deploy to PyPI if desired"
# The confirmation is tested explicitly in `deploy_test`, so we know it is
# either a missing confirmation (so we shouldn't run this job), 'test' or a
# valid confirmation. We don't need to retest the value of the
# confirmation, beyond checking that one existed.
if: ${{ github.event.inputs.confirm_ref != '' && github.event.inputs.confirm_ref != 'test' }}
needs: [deploy_test, build_sdist, build_wheels]
runs-on: ubuntu-latest
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
TWINE_NON_INTERACTIVE: 1
TWINE_REPOSITORY: pypi
steps:
- name: Download build artifacts to local runner
uses: actions/download-artifact@v4
- uses: actions/setup-python@v4
name: Install Python
with:
python-version: '3.10'
- name: Verify this is not a dev version
shell: bash
run: |
python -m pip install wheels/*-cp310-cp310-manylinux*.whl
python -c 'import qutip; print(qutip.__version__); assert "dev" not in qutip.__version__; assert "+" not in qutip.__version__'
# We built the zipfile for convenience distributing to Windows users on
# our end, but PyPI only needs the tarball.
- name: Upload sdist and wheels to PyPI
run: |
python -m pip install "twine"
python -m twine upload --verbose wheels/*.whl sdist/*.tar.gz
deploy_testpypi:
name: "Deploy to TestPyPI if desired"
if: ${{ github.event.inputs.confirm_ref == 'test' }}
needs: [deploy_test, build_sdist, build_wheels]
runs-on: ubuntu-latest
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.TESTPYPI_TOKEN }}
TWINE_NON_INTERACTIVE: 1
steps:
- name: Download build artifacts to local runner
uses: actions/download-artifact@v4
- uses: actions/setup-python@v4
name: Install Python
with:
python-version: '3.10'
- name: Verify this is not a dev version
shell: bash
run: |
python -m pip install wheels/*-cp310-cp310-manylinux*.whl
python -c 'import qutip; print(qutip.__version__); assert "dev" not in qutip.__version__; assert "+" not in qutip.__version__'
# We built the zipfile for convenience distributing to Windows users on
# our end, but PyPI only needs the tarball.
- name: Upload sdist and wheels to TestPyPI
run: |
python -m pip install "twine"
python -m twine upload --repository testpypi --verbose wheels/*.whl sdist/*.tar.gz