pipeline workflow (jonathf/chaospy)

The pipeline workflow from jonathf/chaospy, explained and optimized by Latchkey.

What it does

This is the pipeline workflow from the jonathf/chaospy 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: pipeline

on:
  pull_request:
    branches:
      - master
  push:
    branches:
      - master
    tags:
      - '*'

jobs:
  test:
    name: pipe
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - name: Set up Python 3.12
      uses: actions/setup-python@v5
      with:
        python-version: '3.12'

    - name: Install dependencies
      run: |
        sudo apt update -y && sudo apt install -y pandoc
        python -m pip install --upgrade pip
        pip install -e .[dev]

    - name: Check documentation
      run: |
        sphinx-build docs/ docs/.build -b html -v --color -T -W

    - name: "Run Tests"
      run: |
        coverage run -m pytest --doctest-modules chaospy/ tests/ README.rst
        coverage xml coverage.xml

    - name: "Check formatting"
      run: |
        black --check chaospy/

    - name: "Upload python coverage"
      uses: codecov/codecov-action@v2
      with:
        token: ${{ secrets.codecov_token }}
        files: coverage.xml
        flags: python
        fail_ci_if_error: true

    - name: "Build Wheels"
      run: python -m build

    - uses: pypa/gh-action-pypi-publish@v1.4.2
      if: startsWith(github.ref, 'refs/tags/')
      with:
        user: __token__
        password: ${{ secrets.pypi_password }}

    - name: Verify clean directory
      run: git diff --exit-code

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: pipeline
 
on:
  pull_request:
    branches:
      - master
  push:
    branches:
      - master
    tags:
      - '*'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  test:
    timeout-minutes: 30
    name: pipe
    runs-on: latchkey-small
    steps:
    - uses: actions/checkout@v2
 
    - name: Set up Python 3.12
      uses: actions/setup-python@v5
      with:
        cache: 'pip'
        python-version: '3.12'
 
    - name: Install dependencies
      run: |
        sudo apt update -y && sudo apt install -y pandoc
        python -m pip install --upgrade pip
        pip install -e .[dev]
 
    - name: Check documentation
      run: |
        sphinx-build docs/ docs/.build -b html -v --color -T -W
 
    - name: "Run Tests"
      run: |
        coverage run -m pytest --doctest-modules chaospy/ tests/ README.rst
        coverage xml coverage.xml
 
    - name: "Check formatting"
      run: |
        black --check chaospy/
 
    - name: "Upload python coverage"
      uses: codecov/codecov-action@v2
      with:
        token: ${{ secrets.codecov_token }}
        files: coverage.xml
        flags: python
        fail_ci_if_error: true
 
    - name: "Build Wheels"
      run: python -m build
 
    - uses: pypa/gh-action-pypi-publish@v1.4.2
      if: startsWith(github.ref, 'refs/tags/')
      with:
        user: __token__
        password: ${{ secrets.pypi_password }}
 
    - name: Verify clean directory
      run: git diff --exit-code
 

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.

2 third-party actions are referenced by a movable tag. Pin them 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 per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow