CI workflow (devon-mar/netbox-kea)
The CI workflow from devon-mar/netbox-kea, explained and optimized by Latchkey.
CI health: F - at risk
Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.
What it does
This is the CI workflow from the devon-mar/netbox-kea 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:
- "*"
pull_request:
schedule:
- cron: 0 0 * * 0
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: astral-sh/ruff-action@v3
- uses: astral-sh/ruff-action@v3
with:
args: format --check
test:
strategy:
matrix:
include:
- netbox: v4.4
- netbox: v4.5
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- name: Install uv
uses: astral-sh/setup-uv@v7
with:
enable-cache: true
- name: Setup Python 3.12
id: setup-python
uses: actions/setup-python@v6
with:
python-version-file: pyproject.toml
- name: Ensure playwright browsers are installed
run: uv run playwright install --with-deps
- name: Run uv build
run: uv build
- name: Run test_setup.sh
run: ./tests/test_setup.sh
env:
NETBOX_CONTAINER_TAG: ${{ matrix.netbox }}
- name: Run pytest
run: |
uv run pytest --tracing=retain-on-failure -v
- name: Upload Playwright traces
uses: actions/upload-artifact@v7
if: ${{ !cancelled() }}
with:
name: playwright-traces
path: test-results/
- name: Show Docker logs
if: ${{ always() }}
run: docker compose logs
working-directory: ./tests/docker/
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: - "*" pull_request: schedule: - cron: 0 0 * * 0 concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: lint: timeout-minutes: 30 runs-on: latchkey-small steps: - uses: actions/checkout@v7 - uses: astral-sh/ruff-action@v3 - uses: astral-sh/ruff-action@v3 with: args: format --check test: timeout-minutes: 30 strategy: matrix: include: - netbox: v4.4 - netbox: v4.5 runs-on: latchkey-small steps: - uses: actions/checkout@v7 - name: Install uv uses: astral-sh/setup-uv@v7 with: enable-cache: true - name: Setup Python 3.12 id: setup-python uses: actions/setup-python@v6 with: cache: 'pip' python-version-file: pyproject.toml - name: Ensure playwright browsers are installed run: uv run playwright install --with-deps - name: Run uv build run: uv build - name: Run test_setup.sh run: ./tests/test_setup.sh env: NETBOX_CONTAINER_TAG: ${{ matrix.netbox }} - name: Run pytest run: | uv run pytest --tracing=retain-on-failure -v - name: Upload Playwright traces uses: actions/upload-artifact@v7 if: ${{ !cancelled() }} with: name: playwright-traces path: test-results/ - name: Show Docker logs if: ${{ always() }} run: docker compose logs working-directory: ./tests/docker/
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. - 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:
- End-to-end and browser tests
This workflow runs 2 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.