CI workflow (VectifyAI/OpenKB)
The CI workflow from VectifyAI/OpenKB, explained and optimized by Latchkey.
CI health: A - excellent
Point runs-on at Latchkey and get job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.
What it does
This is the CI workflow from the VectifyAI/OpenKB 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:
push:
branches: ["main"]
pull_request:
# Least-privilege token: this workflow only reads the repo. Arbitrary
# dependency build code runs during install, so never expose a writable
# token to it (see the supply-chain notes in pyproject.toml).
permissions:
contents: read
# Cancel superseded runs on the same ref (rapid PR pushes) instead of
# letting them pile up and post stale statuses.
concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
with:
persist-credentials: false
- uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
with:
version: "0.10.2"
enable-cache: true
# `uv sync --locked` installs the exact uv.lock resolution (direct AND
# transitive deps) and fails if the lock is stale - a bare `pip install`
# would ignore the lockfile and let transitive versions float, defeating
# the repo's exact-pin supply-chain policy. Run `uv lock` and commit the
# lockfile whenever pyproject dependencies change.
- name: Install (locked)
run: uv sync --locked --extra dev --python 3.12
# --no-sync: don't let `uv run` re-sync without the dev extra and
# uninstall the tools it is about to run.
- name: Ruff lint
run: uv run --no-sync ruff check .
- name: Ruff format check
run: uv run --no-sync ruff format --check .
- name: Mypy
run: uv run --no-sync mypy openkb
- name: Pytest
run: uv run --no-sync pytest
The same workflow, on Latchkey
Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.
name: CI on: push: branches: ["main"] pull_request: # Least-privilege token: this workflow only reads the repo. Arbitrary # dependency build code runs during install, so never expose a writable # token to it (see the supply-chain notes in pyproject.toml). permissions: contents: read # Cancel superseded runs on the same ref (rapid PR pushes) instead of # letting them pile up and post stale statuses. concurrency: group: ci-${{ github.ref }} cancel-in-progress: true jobs: check: timeout-minutes: 30 runs-on: latchkey-small steps: - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 with: persist-credentials: false - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0 with: version: "0.10.2" enable-cache: true # `uv sync --locked` installs the exact uv.lock resolution (direct AND # transitive deps) and fails if the lock is stale - a bare `pip install` # would ignore the lockfile and let transitive versions float, defeating # the repo's exact-pin supply-chain policy. Run `uv lock` and commit the # lockfile whenever pyproject dependencies change. - name: Install (locked) run: uv sync --locked --extra dev --python 3.12 # --no-sync: don't let `uv run` re-sync without the dev extra and # uninstall the tools it is about to run. - name: Ruff lint run: uv run --no-sync ruff check . - name: Ruff format check run: uv run --no-sync ruff format --check . - name: Mypy run: uv run --no-sync mypy openkb - name: Pytest run: uv run --no-sync pytest
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 useslatchkey-small; pick the runner size that fits the job. - 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.