CI workflow (cyberjunky/python-garminconnect)

The CI workflow from cyberjunky/python-garminconnect, 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: cyberjunky/python-garminconnect.github/workflows/ci.ymlLicense MITView source

What it does

This is the CI workflow from the cyberjunky/python-garminconnect repository, a real project running GitHub Actions. It is shown here with attribution under its MIT license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

workflow (.yml)

name: CI

"on":
  push:
    branches:
      - main
      - master
      - revamp
  pull_request:
    branches:
      - main
      - master

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.10", "3.11", "3.12", "3.13"]

    steps:
      - uses: actions/checkout@v7

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

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install pdm
          pdm install --group :all

      - name: Lint with ruff
        run: |
          pdm run ruff check .

      - name: Format check with ruff
        run: |
          pdm run ruff format --check .

      - name: Type check with mypy
        run: |
          pdm run mypy garminconnect --ignore-missing-imports

      # - name: Test with pytest
      #   env:
      #     GARMINTOKENS: ${{ secrets.GARMINTOKENS }}
      #   run: |
      #     # Use existing VCR cassettes for CI to avoid network calls
      #     pdm run pytest tests/ -v --tb=short --vcr-record=none
      #   continue-on-error: false

      # - name: Upload coverage reports
      #   if: matrix.python-version == '3.11'
      #   env:
      #     GARMINTOKENS: ${{ secrets.GARMINTOKENS }}
      #   run: |
      #     pdm run coverage run -m pytest -v --tb=short --vcr-record=none
      #     pdm run coverage xml
      #   continue-on-error: true

      - name: Check for coverage report
        id: coverage_check
        run: |
          if [ -f coverage.xml ]; then
            echo "coverage_generated=true" >> "$GITHUB_OUTPUT"
          else
            echo "coverage_generated=false" >> "$GITHUB_OUTPUT"
          fi

      - name: Upload coverage artifact
        if: matrix.python-version == '3.11' && steps.coverage_check.outputs.coverage_generated == 'true'
        uses: actions/upload-artifact@v7
        with:
          name: coverage-xml
          path: coverage.xml

  security:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

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

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install bandit[toml] safety

      - name: Security check with bandit
        run: |
          bandit -r garminconnect -f json -o bandit-report.json || true

      - name: Safety check
        run: |
          safety check --json --output safety-report.json || true
        continue-on-error: true

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:
      - main
      - master
      - revamp
  pull_request:
    branches:
      - main
      - master
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  test:
    timeout-minutes: 30
    runs-on: latchkey-small
    strategy:
      matrix:
        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
    steps:
      - uses: actions/checkout@v7
 
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v6
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
 
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install pdm
          pdm install --group :all
 
      - name: Lint with ruff
        run: |
          pdm run ruff check .
 
      - name: Format check with ruff
        run: |
          pdm run ruff format --check .
 
      - name: Type check with mypy
        run: |
          pdm run mypy garminconnect --ignore-missing-imports
 
      # - name: Test with pytest
      #   env:
      #     GARMINTOKENS: ${{ secrets.GARMINTOKENS }}
      #   run: |
      #     # Use existing VCR cassettes for CI to avoid network calls
      #     pdm run pytest tests/ -v --tb=short --vcr-record=none
      #   continue-on-error: false
 
      # - name: Upload coverage reports
      #   if: matrix.python-version == '3.11'
      #   env:
      #     GARMINTOKENS: ${{ secrets.GARMINTOKENS }}
      #   run: |
      #     pdm run coverage run -m pytest -v --tb=short --vcr-record=none
      #     pdm run coverage xml
      #   continue-on-error: true
 
      - name: Check for coverage report
        id: coverage_check
        run: |
          if [ -f coverage.xml ]; then
            echo "coverage_generated=true" >> "$GITHUB_OUTPUT"
          else
            echo "coverage_generated=false" >> "$GITHUB_OUTPUT"
          fi
 
      - name: Upload coverage artifact
        if: matrix.python-version == '3.11' && steps.coverage_check.outputs.coverage_generated == 'true'
        uses: actions/upload-artifact@v7
        with:
          name: coverage-xml
          path: coverage.xml
 
  security:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v7
 
      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          cache: 'pip'
          python-version: "3.11"
 
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install bandit[toml] safety
 
      - name: Security check with bandit
        run: |
          bandit -r garminconnect -f json -o bandit-report.json || true
 
      - name: Safety check
        run: |
          safety check --json --output safety-report.json || true
        continue-on-error: true

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.

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 2 jobs (5 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

actions/checkout actions/setup-python actions/upload-artifact