Continuous Integration - Quality & Unit Tests workflow (colour-science/colour)
The Continuous Integration - Quality & Unit Tests workflow from colour-science/colour, explained and optimized by Latchkey.
D
CI health: D - needs work
Run this on Latchkey for self-healing, caching, and up to 58% lower cost.
Grade your own workflow free or run it on Latchkey →What it does
This is the Continuous Integration - Quality & Unit Tests workflow from the colour-science/colour repository, a real project running GitHub Actions. It is shown here with attribution under its BSD-3-Clause license.
Below, Latchkey shows a faster, safer version produced by its optimization engine.
The workflow
workflow (.yml)
name: Continuous Integration - Quality & Unit Tests
on: [push, pull_request]
jobs:
continuous-integration-quality-unit-tests:
name: ${{ matrix.os }} - Python ${{ matrix.python-version }}
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: [3.11, 3.12, 3.13, 3.14]
fail-fast: false
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- name: Environment Variables
run: |
echo "CI_PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV
echo "CI_PACKAGE=colour" >> $GITHUB_ENV
echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV
echo "COVERALLS_REPO_TOKEN=${{ secrets.COVERALLS_REPO_TOKEN }}" >> $GITHUB_ENV
echo "MPLBACKEND=AGG" >> $GITHUB_ENV
# https://github.com/scipy/scipy/issues/20613
echo "OMP_NUM_THREADS=1" >> $GITHUB_ENV
shell: bash
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install Dependencies (macOS)
if: matrix.os == 'macOS-latest'
run: |
brew install freeimage
# TODO: Drop when https://github.com/imageio/imageio/issues/628 is addressed
echo "IMAGEIO_FREEIMAGE_LIB=/opt/homebrew/Cellar/freeimage/3.18.0/lib/libfreeimage.3.18.0.dylib" >> $GITHUB_ENV
- name: Install Dependencies (Ubuntu)
if: matrix.os == 'ubuntu-latest'
run: |
sudo apt-get update
sudo apt-get --yes install graphviz graphviz-dev
- name: Install uv
run: |
pip install uv
shell: bash
- name: Install Package Dependencies
run: |
uv sync --all-extras
uv run python -c "import imageio;imageio.plugins.freeimage.download()"
shell: bash
- name: Prek (All Files)
if: matrix.os == 'macOS-latest'
run: |
uv run prek run --all-files
shell: bash
- name: Test Optimised Python Execution
run: |
uv run python -OO -c "import $CI_PACKAGE"
shell: bash
- name: Test with Pytest
run: |
uv run python -W ignore -m pytest --doctest-modules --ignore=$CI_PACKAGE/examples --cov=$CI_PACKAGE $CI_PACKAGE
shell: bash
- name: Upload Coverage to coveralls.io
if: matrix.os == 'macOS-latest' && matrix.python-version == '3.13'
run: |
if [ -z "$COVERALLS_REPO_TOKEN" ]; then echo \"COVERALLS_REPO_TOKEN\" secret is undefined!; else uv run coveralls; fi
shell: bash
The same workflow, on Latchkey
Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.
name: Continuous Integration - Quality & Unit Tests on: [push, pull_request] concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: continuous-integration-quality-unit-tests: timeout-minutes: 30 name: ${{ matrix.os }} - Python ${{ matrix.python-version }} strategy: matrix: os: [macOS-latest, ubuntu-latest, windows-latest] python-version: [3.11, 3.12, 3.13, 3.14] fail-fast: false runs-on: ${{ matrix.os }} steps: - uses: actions/checkout@v4 - name: Environment Variables run: | echo "CI_PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV echo "CI_PACKAGE=colour" >> $GITHUB_ENV echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV echo "COVERALLS_REPO_TOKEN=${{ secrets.COVERALLS_REPO_TOKEN }}" >> $GITHUB_ENV echo "MPLBACKEND=AGG" >> $GITHUB_ENV # https://github.com/scipy/scipy/issues/20613 echo "OMP_NUM_THREADS=1" >> $GITHUB_ENV shell: bash - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v5 with: cache: 'pip' python-version: ${{ matrix.python-version }} - name: Install Dependencies (macOS) if: matrix.os == 'macOS-latest' run: | brew install freeimage # TODO: Drop when https://github.com/imageio/imageio/issues/628 is addressed echo "IMAGEIO_FREEIMAGE_LIB=/opt/homebrew/Cellar/freeimage/3.18.0/lib/libfreeimage.3.18.0.dylib" >> $GITHUB_ENV - name: Install Dependencies (Ubuntu) if: matrix.os == 'ubuntu-latest' run: | sudo apt-get update sudo apt-get --yes install graphviz graphviz-dev - name: Install uv run: | pip install uv shell: bash - name: Install Package Dependencies run: | uv sync --all-extras uv run python -c "import imageio;imageio.plugins.freeimage.download()" shell: bash - name: Prek (All Files) if: matrix.os == 'macOS-latest' run: | uv run prek run --all-files shell: bash - name: Test Optimised Python Execution run: | uv run python -OO -c "import $CI_PACKAGE" shell: bash - name: Test with Pytest run: | uv run python -W ignore -m pytest --doctest-modules --ignore=$CI_PACKAGE/examples --cov=$CI_PACKAGE $CI_PACKAGE shell: bash - name: Upload Coverage to coveralls.io if: matrix.os == 'macOS-latest' && matrix.python-version == '3.13' run: | if [ -z "$COVERALLS_REPO_TOKEN" ]; then echo \"COVERALLS_REPO_TOKEN\" secret is undefined!; else uv run coveralls; fi shell: bash
What changed
- Cancel superseded runs when a branch or PR gets a newer push.
- Cache dependency installs on the setup step so they are served from cache.
- Add a job timeout so a hung step cannot burn hours of runner time.
What Latchkey heals here
This workflow has steps that commonly fail on transient issues (network, registries, flaky browsers). On Latchkey managed runners they are detected, retried, and self-healed instead of failing your build:
- Dependency installs
This workflow runs 1 job (12 with the matrix expanded) per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.