Skip to content
Latchkey

Testing Core Components workflow (AuvaLab/itext2kg)

The Testing Core Components workflow from AuvaLab/itext2kg, explained and optimized by Latchkey.

C

CI health: C - fair

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

Grade your own workflow free or run it on Latchkey →
Source: AuvaLab/itext2kg.github/workflows/testing_matcher.ymlLicense Apache-2.0View source

What it does

This is the Testing Core Components workflow from the AuvaLab/itext2kg 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: Testing Core Components
on:
  pull_request:
    paths:
      - "itext2kg/**"
      - "tests/**"
      - "requirements.txt"
      - "pyproject.toml"
      - "setup.cfg"
  push:
    branches:
      - "main"
    paths:
      - "itext2kg/**"
      - "tests/**"
      - "requirements.txt"
      - "pyproject.toml"
      - "setup.cfg"

jobs:
  test:
    runs-on: ubuntu-latest
    timeout-minutes: 15

    strategy:
      matrix:
        python-version: ["3.10", "3.11", "3.12"] # List of Python versions to test

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

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

      - name: Cache uv folder
        id: cache-uv
        uses: actions/cache@v4
        with:
          path: ~/.cache/uv
          key: ${{ runner.os }}-python-${{ matrix.python-version }}-uv-${{ hashFiles('requirements.txt') }}

      - name: Install uv
        run: curl -LsSf https://astral.sh/uv/install.sh | sh

      - name: Install dependencies
        run: uv pip install --system -r requirements.txt

      - name: Cache .pytest_cache folder
        id: pytest_cache
        uses: actions/cache@v4
        with:
          path: .pytest_cache
          key: pytest_cache-${{ github.head_ref }}

      - name: Run unit tests
        run: python -m pytest tests/ -v --tb=short

      - name: Test import of main components
        run: |
          python -c "from itext2kg import Atom, iText2KG, iText2KG_Star; print('✅ Main components import successful')"
          python -c "from itext2kg.atom import GraphMatcher; print('✅ Atom GraphMatcher import successful')"
          python -c "from itext2kg.atom.models import Entity, Relationship, KnowledgeGraph; print('✅ Atom Models import successful')"
          python -c "from itext2kg.itext2kg_star.models import Entity, Relationship, KnowledgeGraph; print('✅ iText2KG Models import successful')"

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: Testing Core Components
on:
  pull_request:
    paths:
      - "itext2kg/**"
      - "tests/**"
      - "requirements.txt"
      - "pyproject.toml"
      - "setup.cfg"
  push:
    branches:
      - "main"
    paths:
      - "itext2kg/**"
      - "tests/**"
      - "requirements.txt"
      - "pyproject.toml"
      - "setup.cfg"
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  test:
    runs-on: latchkey-small
    timeout-minutes: 15
 
    strategy:
      matrix:
        python-version: ["3.10", "3.11", "3.12"] # List of Python versions to test
 
    steps:
      - name: Check out the code
        uses: actions/checkout@v4
 
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
 
      - name: Cache uv folder
        id: cache-uv
        uses: actions/cache@v4
        with:
          path: ~/.cache/uv
          key: ${{ runner.os }}-python-${{ matrix.python-version }}-uv-${{ hashFiles('requirements.txt') }}
 
      - name: Install uv
        run: curl -LsSf https://astral.sh/uv/install.sh | sh
 
      - name: Install dependencies
        run: uv pip install --system -r requirements.txt
 
      - name: Cache .pytest_cache folder
        id: pytest_cache
        uses: actions/cache@v4
        with:
          path: .pytest_cache
          key: pytest_cache-${{ github.head_ref }}
 
      - name: Run unit tests
        run: python -m pytest tests/ -v --tb=short
 
      - name: Test import of main components
        run: |
          python -c "from itext2kg import Atom, iText2KG, iText2KG_Star; print('✅ Main components import successful')"
          python -c "from itext2kg.atom import GraphMatcher; print('✅ Atom GraphMatcher import successful')"
          python -c "from itext2kg.atom.models import Entity, Relationship, KnowledgeGraph; print('✅ Atom Models import successful')"
          python -c "from itext2kg.itext2kg_star.models import Entity, Relationship, KnowledgeGraph; print('✅ iText2KG Models import successful')"

What changed

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:

This workflow runs 1 job (3 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