all workflow (whyhow-ai/rule-based-retrieval)

The all workflow from whyhow-ai/rule-based-retrieval, explained and optimized by Latchkey.

What it does

This is the all workflow from the whyhow-ai/rule-based-retrieval 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: all

on:
  pull_request:
  push:
    branches: [main]

jobs:
  build:

    runs-on:  ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest]
        python-version: ['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 Python dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -e .[dev]

    - name: Lint with flake8
      run: |
        flake8 src tests examples

    - name: Check style with black
      run: |
        black src tests examples

    - name: Run security check
      run: |
        bandit -qr -c pyproject.toml src examples

    - name: Run import check
      run: |
        isort --check src tests examples

    - name: Run mypy
      run: |
        mypy src

    - name: Test with pytest
      run: |
        pytest --color=yes

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: all
 
on:
  pull_request:
  push:
    branches: [main]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
 
    runs-on:  ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest]
        python-version: ['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 Python dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -e .[dev]
 
    - name: Lint with flake8
      run: |
        flake8 src tests examples
 
    - name: Check style with black
      run: |
        black src tests examples
 
    - name: Run security check
      run: |
        bandit -qr -c pyproject.toml src examples
 
    - name: Run import check
      run: |
        isort --check src tests examples
 
    - name: Run mypy
      run: |
        mypy src
 
    - name: Test with pytest
      run: |
        pytest --color=yes
 

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

Actions used in this workflow