maincheck workflow (cuthbertLab/music21)

The maincheck workflow from cuthbertLab/music21, 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: cuthbertLab/music21.github/workflows/maincheck.ymlLicense BSD-3-ClauseView source

What it does

This is the maincheck workflow from the cuthbertLab/music21 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: maincheck

on:
    push:
        branches:
        - master
        - '*CI*'
    pull_request:
        branches:
        - '*'

jobs:
    run_tests:
        runs-on: ubuntu-latest
        strategy:
            matrix:
                python-version: [3.12, 3.13, 3.14]
        steps:
        - uses: actions/checkout@v4
        - uses: actions/setup-python@v5
          with:
              python-version: ${{ matrix.python-version }}
        - name: Install uv
          uses: astral-sh/setup-uv@v7
          with:
              enable-cache: true
              cache-dependency-glob: |
                  pyproject.toml
                  uv.lock
        - name: Install dependencies
          run: |
              uv sync --locked
        - name: Install Ubuntu dependencies
          run: ./.github/scripts/install_ubuntu_deps.sh
        - name: Setup Lilypond
          run: uv run python -c 'from music21 import environment; environment.UserSettings()["lilypondPath"] = "/home/runner/bin/lilypond"'
        - name: Run Main Test script
          run: uv run python -c 'from music21.test.testSingleCoreAll import ciMain as ci; ci()'
        - name: Coveralls
          if: ${{ matrix.python-version == '3.13' }}
          env:  # when changing number above also change coverageM21.getCoverage
              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
              COVERALLS_SERVICE_NAME: github
          run: uv run coveralls

    lint:
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v4
            - name: Set up Python
              uses: actions/setup-python@v5
              with:
                  python-version: '3.14'
            - name: Install uv
              uses: astral-sh/setup-uv@v7
              with:
                  enable-cache: true
                  cache-dependency-glob: |
                      pyproject.toml
                      uv.lock
            - name: Install dependencies
              run: |
                  uv sync --locked
            - name: Lint with pylint
              run: |
                  uv run pylint -j0 music21
                  uv run pylint -j0 documentation

    ruff:
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v4
            - name: Set up Python
              uses: actions/setup-python@v5
              with:
                  python-version: '3.14'
            - name: Install uv
              uses: astral-sh/setup-uv@v7
              with:
                  enable-cache: true
                  cache-dependency-glob: |
                      pyproject.toml
                      uv.lock
            - name: Install dependencies
              run: |
                  uv sync --locked
            - name: Code-style etc. with Ruff
              run: |
                  uv run ruff check music21
                  uv run ruff check documentation

    mypy:
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v4
            - name: Set up Python
              uses: actions/setup-python@v5
              with:
                  python-version: '3.14'
            - name: Install uv
              uses: astral-sh/setup-uv@v7
              with:
                  enable-cache: true
                  cache-dependency-glob: |
                      pyproject.toml
                      uv.lock
            - name: Install dependencies
              run: |
                  uv sync --locked
            - name: Type-check all modules with mypy
              run: |
                  uv run mypy music21

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: maincheck
 
on:
    push:
        branches:
        - master
        - '*CI*'
    pull_request:
        branches:
        - '*'
 
concurrency:
    group: ${{ github.workflow }}-${{ github.ref }}
    cancel-in-progress: true
 
jobs:
    run_tests:
        timeout-minutes: 30
        runs-on: latchkey-small
        strategy:
            matrix:
                python-version: [3.12, 3.13, 3.14]
        steps:
        - uses: actions/checkout@v4
        - uses: actions/setup-python@v5
          with:
              cache: 'pip'
              python-version: ${{ matrix.python-version }}
        - name: Install uv
          uses: astral-sh/setup-uv@v7
          with:
              enable-cache: true
              cache-dependency-glob: |
                  pyproject.toml
                  uv.lock
        - name: Install dependencies
          run: |
              uv sync --locked
        - name: Install Ubuntu dependencies
          run: ./.github/scripts/install_ubuntu_deps.sh
        - name: Setup Lilypond
          run: uv run python -c 'from music21 import environment; environment.UserSettings()["lilypondPath"] = "/home/runner/bin/lilypond"'
        - name: Run Main Test script
          run: uv run python -c 'from music21.test.testSingleCoreAll import ciMain as ci; ci()'
        - name: Coveralls
          if: ${{ matrix.python-version == '3.13' }}
          env:  # when changing number above also change coverageM21.getCoverage
              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
              COVERALLS_SERVICE_NAME: github
          run: uv run coveralls
 
    lint:
        timeout-minutes: 30
        runs-on: latchkey-small
        steps:
            - uses: actions/checkout@v4
            - name: Set up Python
              uses: actions/setup-python@v5
              with:
                  cache: 'pip'
                  python-version: '3.14'
            - name: Install uv
              uses: astral-sh/setup-uv@v7
              with:
                  enable-cache: true
                  cache-dependency-glob: |
                      pyproject.toml
                      uv.lock
            - name: Install dependencies
              run: |
                  uv sync --locked
            - name: Lint with pylint
              run: |
                  uv run pylint -j0 music21
                  uv run pylint -j0 documentation
 
    ruff:
        timeout-minutes: 30
        runs-on: latchkey-small
        steps:
            - uses: actions/checkout@v4
            - name: Set up Python
              uses: actions/setup-python@v5
              with:
                  cache: 'pip'
                  python-version: '3.14'
            - name: Install uv
              uses: astral-sh/setup-uv@v7
              with:
                  enable-cache: true
                  cache-dependency-glob: |
                      pyproject.toml
                      uv.lock
            - name: Install dependencies
              run: |
                  uv sync --locked
            - name: Code-style etc. with Ruff
              run: |
                  uv run ruff check music21
                  uv run ruff check documentation
 
    mypy:
        timeout-minutes: 30
        runs-on: latchkey-small
        steps:
            - uses: actions/checkout@v4
            - name: Set up Python
              uses: actions/setup-python@v5
              with:
                  cache: 'pip'
                  python-version: '3.14'
            - name: Install uv
              uses: astral-sh/setup-uv@v7
              with:
                  enable-cache: true
                  cache-dependency-glob: |
                      pyproject.toml
                      uv.lock
            - name: Install dependencies
              run: |
                  uv sync --locked
            - name: Type-check all modules with mypy
              run: |
                  uv run mypy music21

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.

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.

This workflow runs 4 jobs (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 astral-sh/setup-uv