CI workflow (jbesomi/texthero)

The CI workflow from jbesomi/texthero, explained and optimized by Latchkey.

What it does

This is the CI workflow from the jbesomi/texthero 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: CI

on:
  push:
    branches: [master]
  pull_request:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref_name }}-${{ github.event.pull_request.number || github.sha }}
  cancel-in-progress: true

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.8", "3.9", "3.10", "3.11"]
    steps:
      - name: Checkout project
        uses: actions/checkout@v3

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v3
        with:
          python-version: ${{ matrix.python-version }}

      - name: Set up venv
        shell: bash
        run: |
          python3 -m pip install --upgrade pip setuptools
          python3 -m venv .venv

      - name: Install project
        shell: bash
        run: |
          source .venv/bin/activate
          python3 -m pip install ".[dev]"

      - name: Test
        run: .venv/bin/python3 -m pytest --cov=texthero --cov-report=term-missing --cov-report xml --cov-branch

      - name: Upload coverage reports to Codecov
        uses: codecov/codecov-action@v3

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: CI
 
on:
  push:
    branches: [master]
  pull_request:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref_name }}-${{ github.event.pull_request.number || github.sha }}
  cancel-in-progress: true
 
jobs:
  test:
    timeout-minutes: 30
    runs-on: latchkey-small
    strategy:
      matrix:
        python-version: ["3.8", "3.9", "3.10", "3.11"]
    steps:
      - name: Checkout project
        uses: actions/checkout@v3
 
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v3
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
 
      - name: Set up venv
        shell: bash
        run: |
          python3 -m pip install --upgrade pip setuptools
          python3 -m venv .venv
 
      - name: Install project
        shell: bash
        run: |
          source .venv/bin/activate
          python3 -m pip install ".[dev]"
 
      - name: Test
        run: .venv/bin/python3 -m pytest --cov=texthero --cov-report=term-missing --cov-report xml --cov-branch
 
      - name: Upload coverage reports to Codecov
        uses: codecov/codecov-action@v3
 

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.
• 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 (4 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