notebooks workflow (neurolib-dev/neurolib)

The notebooks workflow from neurolib-dev/neurolib, explained and optimized by Latchkey.

What it does

This is the notebooks workflow from the neurolib-dev/neurolib 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

name: notebooks

on:
  push:
  pull_request:

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest]
        python-version: [3.7]

    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }} 🚜
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies 🛠
        run: |
          python -m pip install --upgrade pip
          pip install treon wheel setuptools jupyterlab matplotlib seaborn
          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
          pip uninstall -y importlib-metadata
          pip install "importlib-metadata<5.0"
          pip install .
      - name: Test notebooks with treon 🧪
        run: |
          treon examples/

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: notebooks
 
on:
  push:
  pull_request:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest]
        python-version: [3.7]
 
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }} 🚜
        uses: actions/setup-python@v2
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies 🛠
        run: |
          python -m pip install --upgrade pip
          pip install treon wheel setuptools jupyterlab matplotlib seaborn
          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
          pip uninstall -y importlib-metadata
          pip install "importlib-metadata<5.0"
          pip install .
      - name: Test notebooks with treon 🧪
        run: |
          treon examples/
 

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