Python package workflow (keunwoochoi/kapre)

The Python package workflow from keunwoochoi/kapre, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: keunwoochoi/kapre.github/workflows/python-package.ymlLicense MITView source

What it does

This is the Python package workflow from the keunwoochoi/kapre repository, a real project running GitHub Actions. It is shown here with attribution under its MIT license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

workflow (.yml)

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: Python package

on:
  push:
    branches: [ "master" ]
  pull_request:
    branches: [ "master" ]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        include:
          - python-version: "3.9"
            tensorflow-package: ""
          - python-version: "3.10"
            tensorflow-package: ""
          - python-version: "3.11"
            tensorflow-package: ""
          - python-version: "3.12"
            tensorflow-package: ""
          # TensorFlow 2.20 is currently the only <2.21 release with CPython 3.13 wheels.
          - python-version: "3.13"
            tensorflow-package: "tensorflow==2.20.*"

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
        cache: "pip"
    - name: Install dependencies
      env:
        TENSORFLOW_PACKAGE: ${{ matrix.tensorflow-package }}
      run: |
        python -m pip install --upgrade pip
        # TensorFlow Lite conversion fails with Keras 3.14.x on Python >= 3.12.
        python -m pip install pytest "keras<3.14"
        if [ -n "$TENSORFLOW_PACKAGE" ]; then
          python -m pip install "$TENSORFLOW_PACKAGE"
        fi
        python -m pip install .
    # - name: Lint with flake8
    #   run: |
    #     # stop the build if there are Python syntax errors or undefined names
    #     flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
    #     # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
    #     flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
    - name: Test with pytest
      run: |
        pytest

  oldest-supported:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python 3.9
      uses: actions/setup-python@v5
      with:
        python-version: "3.9"
        cache: "pip"
    - name: Install oldest supported dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install pytest numpy==1.26.4 librosa==0.11.0 "keras<3.14" tensorflow==2.16.2
        python -m pip install --no-deps .
    - name: Test with pytest
      run: |
        pytest

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
name: Python package
 
on:
  push:
    branches: [ "master" ]
  pull_request:
    branches: [ "master" ]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
 
    runs-on: latchkey-small
    strategy:
      fail-fast: false
      matrix:
        include:
          - python-version: "3.9"
            tensorflow-package: ""
          - python-version: "3.10"
            tensorflow-package: ""
          - python-version: "3.11"
            tensorflow-package: ""
          - python-version: "3.12"
            tensorflow-package: ""
          # TensorFlow 2.20 is currently the only <2.21 release with CPython 3.13 wheels.
          - python-version: "3.13"
            tensorflow-package: "tensorflow==2.20.*"
 
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
        cache: "pip"
    - name: Install dependencies
      env:
        TENSORFLOW_PACKAGE: ${{ matrix.tensorflow-package }}
      run: |
        python -m pip install --upgrade pip
        # TensorFlow Lite conversion fails with Keras 3.14.x on Python >= 3.12.
        python -m pip install pytest "keras<3.14"
        if [ -n "$TENSORFLOW_PACKAGE" ]; then
          python -m pip install "$TENSORFLOW_PACKAGE"
        fi
        python -m pip install .
    # - name: Lint with flake8
    #   run: |
    #     # stop the build if there are Python syntax errors or undefined names
    #     flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
    #     # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
    #     flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
    - name: Test with pytest
      run: |
        pytest
 
  oldest-supported:
    timeout-minutes: 30
 
    runs-on: latchkey-small
 
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python 3.9
      uses: actions/setup-python@v5
      with:
        python-version: "3.9"
        cache: "pip"
    - name: Install oldest supported dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install pytest numpy==1.26.4 librosa==0.11.0 "keras<3.14" tensorflow==2.16.2
        python -m pip install --no-deps .
    - name: Test with pytest
      run: |
        pytest

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.
Cancel superseded runs when a branch or PR gets a newer push.
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 2 jobs 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