CI workflow (kerrickstaley/genanki)

The CI workflow from kerrickstaley/genanki, explained and optimized by Latchkey.

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 →

Source: kerrickstaley/genanki.github/workflows/ci.ymlLicense MITView source

What it does

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

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  test:
    runs-on: ${{ matrix.os }}-latest
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu, macos, windows]
        python-version: [3.8, 3.11]
        anki-version: [ed8340a4e3a2006d6285d7adf9b136c735ba2085]
    steps:
      - uses: actions/checkout@v2
      - if: ${{ matrix.os == 'ubuntu' }}
        run: sudo apt-get install portaudio19-dev python3-dev
      - if: ${{ matrix.os == 'macos' }}
        run: brew install portaudio
      - uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - run: python3 -m pip install --upgrade pip wheel setuptools
      - if: ${{ matrix.os == 'windows' }}
        run: python3 -m pip install pywin32
      - name: install package and tests_require from setup.py
        run: python3 -m pip install -e ".[test]" pytest-cov codecov
      - run: |
          git clone https://github.com/ankitects/anki.git anki_upstream
          cd anki_upstream
          git reset --hard ${{ matrix.anki-version }}
          python3 -m pip install -r requirements.txt
      - run: |
          python3 -m pytest tests -vv --cov genanki --cov-report term-missing:skip-covered --no-cov-on-fail
      - run: codecov

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:
      - main
  pull_request:
    branches:
      - main
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  test:
    timeout-minutes: 30
    runs-on: ${{ matrix.os }}-latest
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu, macos, windows]
        python-version: [3.8, 3.11]
        anki-version: [ed8340a4e3a2006d6285d7adf9b136c735ba2085]
    steps:
      - uses: actions/checkout@v2
      - if: ${{ matrix.os == 'ubuntu' }}
        run: sudo apt-get install portaudio19-dev python3-dev
      - if: ${{ matrix.os == 'macos' }}
        run: brew install portaudio
      - uses: actions/setup-python@v2
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
      - run: python3 -m pip install --upgrade pip wheel setuptools
      - if: ${{ matrix.os == 'windows' }}
        run: python3 -m pip install pywin32
      - name: install package and tests_require from setup.py
        run: python3 -m pip install -e ".[test]" pytest-cov codecov
      - run: |
          git clone https://github.com/ankitects/anki.git anki_upstream
          cd anki_upstream
          git reset --hard ${{ matrix.anki-version }}
          python3 -m pip install -r requirements.txt
      - run: |
          python3 -m pytest tests -vv --cov genanki --cov-report term-missing:skip-covered --no-cov-on-fail
      - run: codecov

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