Test workflow (scherroman/mugen)

The Test workflow from scherroman/mugen, explained and optimized by Latchkey.

CI health: F - at risk

Point runs-on at Latchkey and get caching, 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: scherroman/mugen.github/workflows/test.ymlLicense MITView source

What it does

This is the Test workflow from the scherroman/mugen 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: Test

on:
    push:
        branches: [master]
        paths-ignore:
            - '**.md'
    pull_request:
        branches: [master]
        paths-ignore:
            - '**.md'

jobs:
    lint:
        name: lint
        runs-on: ubuntu-latest
        steps:
            - name: Check out repository
              uses: actions/checkout@v2

            - uses: actions/setup-python@v2
              with:
                  python-version: '3.9'

            - name: Install dependencies
              run: pip install black==22.3.0 isort==5.10.1 flake8==4.0.1

            - name: Ensure code has been formatted with black
              run: black mugen scripts tests --check

            - name: Ensure imports have been sorted with isort
              run: isort mugen scripts tests --check-only

            - name: Run linter
              run: flake8
    test:
        needs: lint
        name: ${{ matrix.operating-system }}
        runs-on: ${{ matrix.operating-system }}-latest
        strategy:
            fail-fast: false
            matrix:
                operating-system: ['ubuntu', 'macos', 'windows']
        defaults:
            run:
                # Ensure conda environment is activated for each step
                shell: bash -l {0}
        steps:
            - name: Check out repository
              uses: actions/checkout@v2

            - name: Check out media repository
              uses: actions/checkout@v2
              with:
                  repository: scherroman/mugen-media
                  path: media

            - name: Set up Miniconda
              uses: conda-incubator/setup-miniconda@v2
              with:
                  miniconda-version: ${{ env.ACT && 'latest' || '' }}
                  auto-activate-base: false
                  environment-file: environment.yml
                  activate-environment: mugen

            - name: Install dependencies
              run: pip install .[tests]

            - name: Run tests
              run: pytest -n auto --cov mugen --cov-report xml

            - name: Upload test coverage to Codecov
              uses: codecov/codecov-action@v2
              if: ${{ !env.ACT }}
              with:
                  files: coverage.xml
                  fail_ci_if_error: true
                  token: ${{ secrets.CODECOV_TOKEN }}

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: Test
 
on:
    push:
        branches: [master]
        paths-ignore:
            - '**.md'
    pull_request:
        branches: [master]
        paths-ignore:
            - '**.md'
 
concurrency:
    group: ${{ github.workflow }}-${{ github.ref }}
    cancel-in-progress: true
 
jobs:
    lint:
        timeout-minutes: 30
        name: lint
        runs-on: latchkey-small
        steps:
            - name: Check out repository
              uses: actions/checkout@v2
 
            - uses: actions/setup-python@v2
              with:
                  cache: 'pip'
                  python-version: '3.9'
 
            - name: Install dependencies
              run: pip install black==22.3.0 isort==5.10.1 flake8==4.0.1
 
            - name: Ensure code has been formatted with black
              run: black mugen scripts tests --check
 
            - name: Ensure imports have been sorted with isort
              run: isort mugen scripts tests --check-only
 
            - name: Run linter
              run: flake8
    test:
        timeout-minutes: 30
        needs: lint
        name: ${{ matrix.operating-system }}
        runs-on: ${{ matrix.operating-system }}-latest
        strategy:
            fail-fast: false
            matrix:
                operating-system: ['ubuntu', 'macos', 'windows']
        defaults:
            run:
                # Ensure conda environment is activated for each step
                shell: bash -l {0}
        steps:
            - name: Check out repository
              uses: actions/checkout@v2
 
            - name: Check out media repository
              uses: actions/checkout@v2
              with:
                  repository: scherroman/mugen-media
                  path: media
 
            - name: Set up Miniconda
              uses: conda-incubator/setup-miniconda@v2
              with:
                  miniconda-version: ${{ env.ACT && 'latest' || '' }}
                  auto-activate-base: false
                  environment-file: environment.yml
                  activate-environment: mugen
 
            - name: Install dependencies
              run: pip install .[tests]
 
            - name: Run tests
              run: pytest -n auto --cov mugen --cov-report xml
 
            - name: Upload test coverage to Codecov
              uses: codecov/codecov-action@v2
              if: ${{ !env.ACT }}
              with:
                  files: coverage.xml
                  fail_ci_if_error: true
                  token: ${{ secrets.CODECOV_TOKEN }}

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

2 third-party actions are referenced by a movable tag. Pin them 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 (4 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 codecov/codecov-action