API Boundary Check workflow (ruaan-deysel/ha-unraid)

The API Boundary Check workflow from ruaan-deysel/ha-unraid, explained and optimized by Latchkey.

CI health: D - needs work

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

Grade your own workflow free or run it on Latchkey →

Source: ruaan-deysel/ha-unraid.github/workflows/check-api-boundary.ymlLicense Apache-2.0View source

What it does

This is the API Boundary Check workflow from the ruaan-deysel/ha-unraid 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: API Boundary Check

# Blocks merges that bypass the unraid-api library with direct network I/O.
# All Unraid server communication MUST go through UnraidClient (unraid-api).
# Missing library features → open an issue at https://github.com/ruaan-deysel/unraid-api

on:
  push:
    paths:
      - "custom_components/unraid/**/*.py"
      - "script/check_api_boundary.py"
  pull_request:
    paths:
      - "custom_components/unraid/**/*.py"
      - "script/check_api_boundary.py"

permissions:
  contents: read

jobs:
  api-boundary:
    name: No unraid-api bypass
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0

      - name: Set up Python
        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6
        with:
          python-version: "3.13"

      - name: Check API boundary
        run: python script/check_api_boundary.py

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: API Boundary Check
 
# Blocks merges that bypass the unraid-api library with direct network I/O.
# All Unraid server communication MUST go through UnraidClient (unraid-api).
# Missing library features → open an issue at https://github.com/ruaan-deysel/unraid-api
 
on:
  push:
    paths:
      - "custom_components/unraid/**/*.py"
      - "script/check_api_boundary.py"
  pull_request:
    paths:
      - "custom_components/unraid/**/*.py"
      - "script/check_api_boundary.py"
 
permissions:
  contents: read
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  api-boundary:
    timeout-minutes: 30
    name: No unraid-api bypass
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
 
      - name: Set up Python
        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6
        with:
          cache: 'pip'
          python-version: "3.13"
 
      - name: Check API boundary
        run: python script/check_api_boundary.py

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.
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.

This workflow runs 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow

actions/checkout actions/setup-python