Run tests in Ubuntu and Mac workflow (marcwebbie/passpie)

The Run tests in Ubuntu and Mac workflow from marcwebbie/passpie, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get run de-duplication, 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: marcwebbie/passpie.github/workflows/tests.ymlLicense MITView source

What it does

This is the Run tests in Ubuntu and Mac workflow from the marcwebbie/passpie 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)

name: Run tests in Ubuntu and Mac
on:
  workflow_call:
  push:
    branches:
      - master
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  tests-with-coverage-3-12:
    name: Run tests on Ubuntu latest py3.12
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Install depedencies
        # python-setuptools fix ModuleNotFoundError: No module named 'pkg_resources'
        run: |
          sudo apt-get install -y gnupg2 python-setuptools
      - name: Setup Python 3.12.2
        uses: actions/setup-python@v5
        with:
          python-version: "3.12.2"
          cache: "pip"
          cache-dependency-path: '**/setup.py'
      - name: Install requirements
        run: |
          python -m pip install --upgrade pip
          pip install -e . -r requirements/test.txt
      - name: Run tests
        run: |
          pytest --color=yes

  tests-with-coverage-mac:
    name: Run tests on macos 11 py3.12
    runs-on: macos-11
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Install depedencies
        run: |
          brew install gnupg
          sudo pip3 install setuptools
      - name: Setup Python 3.12.2
        uses: actions/setup-python@v5
        with:
          python-version: "3.12.2"
          cache: "pip"
          cache-dependency-path: '**/setup.py'
      - name: Install requirements
        run: |
          python -m pip install --upgrade pip
          pip install -e . -r requirements/test.txt
          pip install coveralls
      - name: Run tests
        run: |
          pytest --color=yes
      # - name: Coveralls
      #   uses: coverallsapp/github-action@master
      #   with:
      #     github-token: ${{ secrets.GITHUB_TOKEN }}
      #     path-to-lcov: coverage.xml

The same workflow, on Latchkey

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

name: Run tests in Ubuntu and Mac
on:
  workflow_call:
  push:
    branches:
      - master
  pull_request:
    types: [opened, synchronize, reopened]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  tests-with-coverage-3-12:
    timeout-minutes: 30
    name: Run tests on Ubuntu latest py3.12
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Install depedencies
        # python-setuptools fix ModuleNotFoundError: No module named 'pkg_resources'
        run: |
          sudo apt-get install -y gnupg2 python-setuptools
      - name: Setup Python 3.12.2
        uses: actions/setup-python@v5
        with:
          python-version: "3.12.2"
          cache: "pip"
          cache-dependency-path: '**/setup.py'
      - name: Install requirements
        run: |
          python -m pip install --upgrade pip
          pip install -e . -r requirements/test.txt
      - name: Run tests
        run: |
          pytest --color=yes
 
  tests-with-coverage-mac:
    timeout-minutes: 30
    name: Run tests on macos 11 py3.12
    runs-on: macos-11
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Install depedencies
        run: |
          brew install gnupg
          sudo pip3 install setuptools
      - name: Setup Python 3.12.2
        uses: actions/setup-python@v5
        with:
          python-version: "3.12.2"
          cache: "pip"
          cache-dependency-path: '**/setup.py'
      - name: Install requirements
        run: |
          python -m pip install --upgrade pip
          pip install -e . -r requirements/test.txt
          pip install coveralls
      - name: Run tests
        run: |
          pytest --color=yes
      # - name: Coveralls
      #   uses: coverallsapp/github-action@master
      #   with:
      #     github-token: ${{ secrets.GITHUB_TOKEN }}
      #     path-to-lcov: coverage.xml

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.

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 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