Docs workflow (bethgelab/foolbox)

The Docs workflow from bethgelab/foolbox, explained and optimized by Latchkey.

What it does

This is the Docs workflow from the bethgelab/foolbox 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: Docs

on:
  push:
    branches:
      - master
  pull_request:

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - uses: actions/cache@v1
      with:
        path: ~/.cache/pip
        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
        restore-keys: |
          ${{ runner.os }}-pip-
    - name: Set up Python 3.8
      uses: actions/setup-python@v1
      with:
        python-version: 3.9
    - name: Install package
      run: |
        pip install -e .
    - name: Install requirements.txt
      run: |
        pip install -r requirements.txt
    - name: Install docs/requirements.txt
      run: |
        python -m pip install --upgrade pip setuptools
        pip install -r docs/requirements.txt
    - name: sphinx
      run: |
        cd docs && make html

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: Docs
 
on:
  push:
    branches:
      - master
  pull_request:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
 
    runs-on: latchkey-small
 
    steps:
    - uses: actions/checkout@v2
    - uses: actions/cache@v1
      with:
        path: ~/.cache/pip
        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
        restore-keys: |
          ${{ runner.os }}-pip-
    - name: Set up Python 3.8
      uses: actions/setup-python@v1
      with:
        cache: 'pip'
        python-version: 3.9
    - name: Install package
      run: |
        pip install -e .
    - name: Install requirements.txt
      run: |
        pip install -r requirements.txt
    - name: Install docs/requirements.txt
      run: |
        python -m pip install --upgrade pip setuptools
        pip install -r docs/requirements.txt
    - name: sphinx
      run: |
        cd docs && make html
 

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 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow