CI workflow (luxonis/oak-examples)

The CI workflow from luxonis/oak-examples, explained and optimized by Latchkey.

What it does

This is the CI workflow from the luxonis/oak-examples 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: CI

on:
  pull_request:
    branches:
      - main

jobs:
  agents-index:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v4

    - name: Validate per-example AGENTS docs
      run: python3 scripts/validate_agents_docs.py

    - name: Check generated AGENTS index
      run: python3 scripts/generate_agents_index.py --check

  pre-commit:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v4

    - name: Install pre-commit
      run: python -m pip install 'pre-commit<4.0.0'

    - name: Run pre-commit
      uses: pre-commit/action@v3.0.1

The same workflow, on Latchkey

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

name: CI
 
on:
  pull_request:
    branches:
      - main
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  agents-index:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
    - name: Checkout
      uses: actions/checkout@v4
 
    - name: Validate per-example AGENTS docs
      run: python3 scripts/validate_agents_docs.py
 
    - name: Check generated AGENTS index
      run: python3 scripts/generate_agents_index.py --check
 
  pre-commit:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
    - name: Checkout
      uses: actions/checkout@v4
 
    - name: Install pre-commit
      run: python -m pip install 'pre-commit<4.0.0'
 
    - name: Run pre-commit
      uses: pre-commit/action@v3.0.1
 

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.

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

Actions used in this workflow