Continuous integration workflow (allenai/OLMoASR)

The Continuous integration workflow from allenai/OLMoASR, explained and optimized by Latchkey.

What it does

This is the Continuous integration workflow from the allenai/OLMoASR 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: Continuous integration

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

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python 3.8
        uses: actions/setup-python@v2
        with:
          python-version: 3.8
      - name: Install
        run: |
          python3 -m venv .env
          source .env/bin/activate
          python -m pip install -U pip
          make install-dev
      - name: Lint
        run: |
          source .env/bin/activate
          make lint
  tests:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.8, '3.10']

    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
      run: |
        python3 -m venv .env
        source .env/bin/activate
        make install
        make install-dev
    - name: Unit tests
      run: |
        source .env/bin/activate
        make test

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: Continuous integration
 
on:
  push:
    branches:
    - main
  pull_request:
    branches:
    - main
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  lint:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python 3.8
        uses: actions/setup-python@v2
        with:
          cache: 'pip'
          python-version: 3.8
      - name: Install
        run: |
          python3 -m venv .env
          source .env/bin/activate
          python -m pip install -U pip
          make install-dev
      - name: Lint
        run: |
          source .env/bin/activate
          make lint
  tests:
    timeout-minutes: 30
    runs-on: latchkey-small
    strategy:
      matrix:
        python-version: [3.8, '3.10']
 
    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
      run: |
        python3 -m venv .env
        source .env/bin/activate
        make install
        make install-dev
    - name: Unit tests
      run: |
        source .env/bin/activate
        make test
 
 

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.

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