Continuous Integration workflow (MushroomRL/mushroom-rl)

The Continuous Integration workflow from MushroomRL/mushroom-rl, 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: MushroomRL/mushroom-rl.github/workflows/continuous_integration.ymlLicense MITView source

What it does

This is the Continuous Integration workflow from the MushroomRL/mushroom-rl 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 single version of Python, upload the coverage results to code climate

name: Continuous Integration

on:
  push:
    branches: [ dev, dev-v1, master ]

jobs:
  build:
    if: github.repository == 'MushroomRL/mushroom-rl'
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.11", "3.12"]

    steps:
    - uses: actions/checkout@v5
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v6
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install flake8 pytest pytest-cov
        pip install -e .[all,bullet]
    - name: Install Atari ROMs
      run: |
        pip install "autorom[accept-rom-license]"
    - 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. Project style uses a 120-char line length
        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=120 --statistics
    - name: Log CPU model
      run: lscpu | grep "Model name"
    - name: Test with pytest
      run: |
        pytest --cov=mushroom_rl --cov-report=xml
    - uses: qltysh/qlty-action/coverage@v2
      if: matrix.python-version == '3.11'
      with:
        token: ${{secrets.QLTY_COVERAGE_TOKEN}}
        files: coverage.xml
        add-prefix: 'mushroom_rl/'

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.

# This workflow will install Python dependencies, run tests and lint with a single version of Python, upload the coverage results to code climate
 
name: Continuous Integration
 
on:
  push:
    branches: [ dev, dev-v1, master ]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    if: github.repository == 'MushroomRL/mushroom-rl'
    runs-on: latchkey-small
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.11", "3.12"]
 
    steps:
    - uses: actions/checkout@v5
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v6
      with:
        cache: 'pip'
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install flake8 pytest pytest-cov
        pip install -e .[all,bullet]
    - name: Install Atari ROMs
      run: |
        pip install "autorom[accept-rom-license]"
    - 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. Project style uses a 120-char line length
        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=120 --statistics
    - name: Log CPU model
      run: lscpu | grep "Model name"
    - name: Test with pytest
      run: |
        pytest --cov=mushroom_rl --cov-report=xml
    - uses: qltysh/qlty-action/coverage@v2
      if: matrix.python-version == '3.11'
      with:
        token: ${{secrets.QLTY_COVERAGE_TOKEN}}
        files: coverage.xml
        add-prefix: 'mushroom_rl/'

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.

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