CI workflow (tryolabs/norfair)

The CI workflow from tryolabs/norfair, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get caching, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: tryolabs/norfair.github/workflows/ci.ymlLicense BSD-3-ClauseView source

What it does

This is the CI workflow from the tryolabs/norfair 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: CI

on:
  push:
    branches: master
  pull_request:
    branches: master
  release:
    types: [published]

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
  cancel-in-progress: true

jobs:
  #
  # Builds our package and runs the tests under supported
  # versions of Python.
  #
  unit-tests:
    runs-on: ubuntu-22.04
    strategy:
      max-parallel: 3
      matrix:
        python-version: ["3.8", "3.9", "3.10"]
    steps:
      - uses: actions/checkout@v3

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install tox
        run: |
          pip install --upgrade pip
          pip install --upgrade tox

      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.5.1 # to support Python 3.8

      - name: Run tests
        run: |
          tox -e py

  mot-metrics:
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v3

      - name: Set up Python 3.9
        uses: actions/setup-python@v4
        with:
          python-version: "3.9"

      - name: Install tox
        run: |
          pip install --upgrade pip
          pip install --upgrade tox

      - name: Install Poetry
        uses: snok/install-poetry@v1

      - name: Run tests
        run: |
          tox -e mot-py39

  build:
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v3

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: 3.9

      - name: Install Poetry
        uses: snok/install-poetry@v1

      - name: Build package
        run: poetry build -f sdist

      - name: Prepare package
        run: |
          tar xvf "dist/norfair-$(poetry version -s).tar.gz"
          mv norfair-$(poetry version -s) norfair-dist

      - name: Save artifact
        uses: actions/upload-artifact@v4
        with:
          name: norfair-dist
          path: norfair-dist

  install:
    needs: [build]
    runs-on: ubuntu-22.04
    strategy:
      max-parallel: 3
      matrix:
        python-version: ["3.8", "3.9", "3.10"]
    steps:
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}

      - name: Download a single artifact
        uses: actions/download-artifact@v4
        with:
          name: norfair-dist
          path: ./norfair-dist

      - name: Install
        run: pip install ./norfair-dist/

      - name: Test
        run: python -c "import norfair"

  #
  # Build & upload release to PyPI.
  #
  # Executed only if GitHub release is "published".
  #
  release:
    runs-on: ubuntu-22.04
    needs: [unit-tests, mot-metrics]
    if: github.event_name == 'release'
    env:
      PYTHON_VERSION: 3.8
    steps:
      - uses: actions/checkout@v3

      - name: Set up Python ${{ env.PYTHON_VERSION }}
        uses: actions/setup-python@v4
        with:
          python-version: "${{ env.PYTHON_VERSION }}"

      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.5.1 # to support Python 3.8

      - name: Release to PyPI
        env:
          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
        run: |
          poetry config -n pypi-token.pypi "$PYPI_TOKEN"
          poetry publish --build -n


  deploy-doc:
    runs-on: ubuntu-22.04
    needs: [release]
    if: github.event_name == 'release'
    env:
      PYTHON_VERSION: 3.8
    steps:
      - uses: actions/checkout@v3

      - name: Set up Python ${{ env.PYTHON_VERSION }}
        uses: actions/setup-python@v4
        with:
          python-version: "${{ env.PYTHON_VERSION }}"

      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.5.1 # to support Python 3.8

      - name: Install dependencies
        run: pip install -r docs/requirements.txt

      - name: Install dependencies
        run: python docs/deploy_docs.py

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: CI
 
on:
  push:
    branches: master
  pull_request:
    branches: master
  release:
    types: [published]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
  cancel-in-progress: true
 
jobs:
  #
  # Builds our package and runs the tests under supported
  # versions of Python.
  #
  unit-tests:
    timeout-minutes: 30
    runs-on: latchkey-small
    strategy:
      max-parallel: 3
      matrix:
        python-version: ["3.8", "3.9", "3.10"]
    steps:
      - uses: actions/checkout@v3
 
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
 
      - name: Install tox
        run: |
          pip install --upgrade pip
          pip install --upgrade tox
 
      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.5.1 # to support Python 3.8
 
      - name: Run tests
        run: |
          tox -e py
 
  mot-metrics:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v3
 
      - name: Set up Python 3.9
        uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: "3.9"
 
      - name: Install tox
        run: |
          pip install --upgrade pip
          pip install --upgrade tox
 
      - name: Install Poetry
        uses: snok/install-poetry@v1
 
      - name: Run tests
        run: |
          tox -e mot-py39
 
  build:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v3
 
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: 3.9
 
      - name: Install Poetry
        uses: snok/install-poetry@v1
 
      - name: Build package
        run: poetry build -f sdist
 
      - name: Prepare package
        run: |
          tar xvf "dist/norfair-$(poetry version -s).tar.gz"
          mv norfair-$(poetry version -s) norfair-dist
 
      - name: Save artifact
        uses: actions/upload-artifact@v4
        with:
          name: norfair-dist
          path: norfair-dist
 
  install:
    timeout-minutes: 30
    needs: [build]
    runs-on: latchkey-small
    strategy:
      max-parallel: 3
      matrix:
        python-version: ["3.8", "3.9", "3.10"]
    steps:
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
 
      - name: Download a single artifact
        uses: actions/download-artifact@v4
        with:
          name: norfair-dist
          path: ./norfair-dist
 
      - name: Install
        run: pip install ./norfair-dist/
 
      - name: Test
        run: python -c "import norfair"
 
  #
  # Build & upload release to PyPI.
  #
  # Executed only if GitHub release is "published".
  #
  release:
    timeout-minutes: 30
    runs-on: latchkey-small
    needs: [unit-tests, mot-metrics]
    if: github.event_name == 'release'
    env:
      PYTHON_VERSION: 3.8
    steps:
      - uses: actions/checkout@v3
 
      - name: Set up Python ${{ env.PYTHON_VERSION }}
        uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: "${{ env.PYTHON_VERSION }}"
 
      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.5.1 # to support Python 3.8
 
      - name: Release to PyPI
        env:
          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
        run: |
          poetry config -n pypi-token.pypi "$PYPI_TOKEN"
          poetry publish --build -n
 
 
  deploy-doc:
    timeout-minutes: 30
    runs-on: latchkey-small
    needs: [release]
    if: github.event_name == 'release'
    env:
      PYTHON_VERSION: 3.8
    steps:
      - uses: actions/checkout@v3
 
      - name: Set up Python ${{ env.PYTHON_VERSION }}
        uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: "${{ env.PYTHON_VERSION }}"
 
      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.5.1 # to support Python 3.8
 
      - name: Install dependencies
        run: pip install -r docs/requirements.txt
 
      - name: Install dependencies
        run: python docs/deploy_docs.py

What changed

Run on Latchkey managed runners with one line (runs-on), which apply the fixes below automatically and self-heal transient failures. This example uses latchkey-small; pick the runner size that fits the job.
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.

1 third-party action is referenced by a movable tag. Pin it to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.

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 6 jobs (10 with the matrix expanded) per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow

actions/checkout actions/setup-python actions/upload-artifact actions/download-artifact