Tests workflow (mar10/pyftpsync)
The Tests workflow from mar10/pyftpsync, 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 Tests workflow from the mar10/pyftpsync 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
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
name: Tests
on:
push:
branches: ["master"]
pull_request:
branches: ["master"]
permissions:
contents: read
jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
# Python 3.7 # EOL 2023-06-27
# Python 3.8 # EOL 2024-10-14
# Python 3.9 # EOL 2025-10-05
# Python 3.10 # EOL 2026-10-04
# Python 3.11 # EOL 2027-10-24
# Python 3.12 # EOL 2028-10-31
# Python 3.13 # EOL 2029-10-31
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -V
python -m pip install --upgrade pip
python -m pip install setuptools
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
python -m pip install pytest pytest-cov pytest-html ruff
# python -m pip install
pip list
- name: Lint with ruff
run: |
ruff -V
ruff check ftpsync tests setup.py
- name: Test with pytest
run: |
pytest -V
pytest -ra -v -x --durations=10 --cov=ftpsync
# pytest -ra -v -x --durations=10 --cov=ftpsync --html=build/pytest/report-${{ matrix.python-version }}.html --self-contained-html
# pytest -ra -v -x --durations=10 --cov=ftpsync --html=build/pytest/report-{envname}.html --self-contained-html {posargs}
- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v4.0.1
with:
token: ${{ secrets.CODECOV_TOKEN }}
# - name: Coveralls
# uses: coverallsapp/github-action@v2
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.
# This workflow will install Python dependencies, run tests and lint with a single version of Python # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python name: Tests on: push: branches: ["master"] pull_request: branches: ["master"] permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: build: timeout-minutes: 30 runs-on: latchkey-small strategy: fail-fast: false matrix: # Python 3.7 # EOL 2023-06-27 # Python 3.8 # EOL 2024-10-14 # Python 3.9 # EOL 2025-10-05 # Python 3.10 # EOL 2026-10-04 # Python 3.11 # EOL 2027-10-24 # Python 3.12 # EOL 2028-10-31 # Python 3.13 # EOL 2029-10-31 python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] steps: - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v3 with: cache: 'pip' python-version: ${{ matrix.python-version }} - name: Install dependencies run: | python -V python -m pip install --upgrade pip python -m pip install setuptools if [ -f requirements.txt ]; then pip install -r requirements.txt; fi python -m pip install pytest pytest-cov pytest-html ruff # python -m pip install pip list - name: Lint with ruff run: | ruff -V ruff check ftpsync tests setup.py - name: Test with pytest run: | pytest -V pytest -ra -v -x --durations=10 --cov=ftpsync # pytest -ra -v -x --durations=10 --cov=ftpsync --html=build/pytest/report-${{ matrix.python-version }}.html --self-contained-html # pytest -ra -v -x --durations=10 --cov=ftpsync --html=build/pytest/report-{envname}.html --self-contained-html {posargs} - name: Upload coverage reports to Codecov uses: codecov/codecov-action@v4.0.1 with: token: ${{ secrets.CODECOV_TOKEN }} # - name: Coveralls # uses: coverallsapp/github-action@v2
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:
- Dependency installs
This workflow runs 1 job (5 with the matrix expanded) per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.