Test example extensions workflow (hitsz-ids/synthetic-data-generator)

The Test example extensions workflow from hitsz-ids/synthetic-data-generator, explained and optimized by Latchkey.

What it does

This is the Test example extensions workflow from the hitsz-ids/synthetic-data-generator repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

name: Test example extensions

on:
  push:
    branches: ["master", "main"]
  pull_request:
    branches: ["master", "main"]

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.9", "3.12"]

    steps:
      - uses: actions/checkout@v3
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: 'pip'
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -e .[test]
      - name: Install all packages in example/extension
        run: |
          python -m pip install -e example/extension/dummyexporter[test]
          python -m pip install -e example/extension/dummymetadatainspector[test]
          python -m pip install -e example/extension/dummycache[test]
          python -m pip install -e example/extension/dummydataconnector[test]
          python -m pip install -e example/extension/dummydataprocessor[test]
          python -m pip install -e example/extension/dummymodel[test]
      - name: Test with pytest
        run: |
          pytest -vv example/extension

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

name: Test example extensions
 
on:
  push:
    branches: ["master", "main"]
  pull_request:
    branches: ["master", "main"]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    runs-on: latchkey-small
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.9", "3.12"]
 
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: 'pip'
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -e .[test]
      - name: Install all packages in example/extension
        run: |
          python -m pip install -e example/extension/dummyexporter[test]
          python -m pip install -e example/extension/dummymetadatainspector[test]
          python -m pip install -e example/extension/dummycache[test]
          python -m pip install -e example/extension/dummydataconnector[test]
          python -m pip install -e example/extension/dummydataprocessor[test]
          python -m pip install -e example/extension/dummymodel[test]
      - name: Test with pytest
        run: |
          pytest -vv example/extension
 

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