Skip to content
Latchkey

CI (ruff + mypy + pytest) workflow (XTraceAI/xtrace-sdk)

The CI (ruff + mypy + pytest) workflow from XTraceAI/xtrace-sdk, explained and optimized by Latchkey.

B

CI health: B - good

Point runs-on at Latchkey and get caching, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →
Source: XTraceAI/xtrace-sdk.github/workflows/ci.ymlLicense Apache-2.0View source

What it does

This is the CI (ruff + mypy + pytest) workflow from the XTraceAI/xtrace-sdk 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

workflow (.yml)
name: CI (ruff + mypy + pytest)

on:
  pull_request:
    branches:
      - main
  push:
    branches:
      - main
      - staging
      - develop
  workflow_dispatch:  # lets you run it manually from the Actions tab

concurrency:
  group: ci-${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  # ── Lint + type-check + offline unit tests ──────────────────────
  qa:
    name: Quality gates (lint, type-check, unit tests)
    runs-on: ubuntu-latest
    timeout-minutes: 20

    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.12"]

    steps:
      - name: Check out repository
        uses: actions/checkout@v4

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}

      - name: Set up uv
        uses: astral-sh/setup-uv@v4

      - name: Install package + all dev dependencies
        run: uv sync --all-groups

      - name: Ruff lint
        run: uv run ruff check src/xtrace_sdk/ --output-format=github

      # - name: Ruff format (check only)
      #   run: uv run ruff format src/xtrace_sdk/ --check

      - name: Mypy
        run: uv run mypy src/xtrace_sdk/

      - name: Pytest (test_paillier_lookup_encryption)
        run: uv run pytest tests/x_vec/test_paillier_lookup_encryption.py

      - name: Pytest (test_paillier_encryption)
        run: uv run pytest tests/x_vec/test_paillier_encryption.py

  # ── Integration tests (require XTrace API credentials) ──────────
  integration:
    name: Integration tests (meta search + hamming)
    runs-on: ubuntu-latest
    timeout-minutes: 30
    needs: qa                          # only run if qa passes
    if: vars.XTRACE_INTEGRATION_TESTS == 'true'   # opt-in via repo variable

    steps:
      - name: Check out repository
        uses: actions/checkout@v4

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

      - name: Set up uv
        uses: astral-sh/setup-uv@v4

      - name: Install package + all dev dependencies
        run: uv sync --all-groups

      - name: Pytest (test_meta_search)
        env:
          XTRACE_API_KEY:   ${{ secrets.XTRACE_API_KEY }}
          XTRACE_ADMIN_KEY: ${{ secrets.XTRACE_ADMIN_KEY }}
          XTRACE_ORG_ID:    ${{ secrets.XTRACE_ORG_ID }}
        run: uv run pytest tests/x_vec/test_meta_search.py -v

      - name: Pytest (test_hamming_search)
        env:
          XTRACE_API_KEY:   ${{ secrets.XTRACE_API_KEY }}
          XTRACE_ADMIN_KEY: ${{ secrets.XTRACE_ADMIN_KEY }}
          XTRACE_ORG_ID:    ${{ secrets.XTRACE_ORG_ID }}
        run: uv run pytest tests/x_vec/test_hamming_search.py -v

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 (ruff + mypy + pytest)
 
on:
  pull_request:
    branches:
      - main
  push:
    branches:
      - main
      - staging
      - develop
  workflow_dispatch:  # lets you run it manually from the Actions tab
 
concurrency:
  group: ci-${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  # ── Lint + type-check + offline unit tests ──────────────────────
  qa:
    name: Quality gates (lint, type-check, unit tests)
    runs-on: latchkey-small
    timeout-minutes: 20
 
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.12"]
 
    steps:
      - name: Check out repository
        uses: actions/checkout@v4
 
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
 
      - name: Set up uv
        uses: astral-sh/setup-uv@v4
 
      - name: Install package + all dev dependencies
        run: uv sync --all-groups
 
      - name: Ruff lint
        run: uv run ruff check src/xtrace_sdk/ --output-format=github
 
      # - name: Ruff format (check only)
      #   run: uv run ruff format src/xtrace_sdk/ --check
 
      - name: Mypy
        run: uv run mypy src/xtrace_sdk/
 
      - name: Pytest (test_paillier_lookup_encryption)
        run: uv run pytest tests/x_vec/test_paillier_lookup_encryption.py
 
      - name: Pytest (test_paillier_encryption)
        run: uv run pytest tests/x_vec/test_paillier_encryption.py
 
  # ── Integration tests (require XTrace API credentials) ──────────
  integration:
    name: Integration tests (meta search + hamming)
    runs-on: latchkey-small
    timeout-minutes: 30
    needs: qa                          # only run if qa passes
    if: vars.XTRACE_INTEGRATION_TESTS == 'true'   # opt-in via repo variable
 
    steps:
      - name: Check out repository
        uses: actions/checkout@v4
 
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: "3.12"
 
      - name: Set up uv
        uses: astral-sh/setup-uv@v4
 
      - name: Install package + all dev dependencies
        run: uv sync --all-groups
 
      - name: Pytest (test_meta_search)
        env:
          XTRACE_API_KEY:   ${{ secrets.XTRACE_API_KEY }}
          XTRACE_ADMIN_KEY: ${{ secrets.XTRACE_ADMIN_KEY }}
          XTRACE_ORG_ID:    ${{ secrets.XTRACE_ORG_ID }}
        run: uv run pytest tests/x_vec/test_meta_search.py -v
 
      - name: Pytest (test_hamming_search)
        env:
          XTRACE_API_KEY:   ${{ secrets.XTRACE_API_KEY }}
          XTRACE_ADMIN_KEY: ${{ secrets.XTRACE_ADMIN_KEY }}
          XTRACE_ORG_ID:    ${{ secrets.XTRACE_ORG_ID }}
        run: uv run pytest tests/x_vec/test_hamming_search.py -v
 

What changed

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.

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