Python package workflow (EntilZha/PyFunctional)

The Python package workflow from EntilZha/PyFunctional, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get run de-duplication, job timeouts, 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: EntilZha/PyFunctional.github/workflows/pythonpackage.ymlLicense MITView source

What it does

This is the Python package workflow from the EntilZha/PyFunctional 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)

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Python package

on:
  push:
    branches: [master, dev]
  pull_request:
    branches: [master]

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
        include:
          - python-version: "3.11"
            use_pandas: 1
    steps:
      - uses: actions/checkout@v3
      - run: pipx install poetry
      - uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
          cache: poetry
      - run: |
          if ! poetry install; then
            poetry lock
            poetry install
          fi
      - name: Pylint (Python v${{ matrix.python-version }})
        run: poetry run pylint functional
      - name: black (Python v${{ matrix.python-version }})
        run: poetry run black --diff --check functional
        if: always()
      - name: Test with pytest (Python v${{ matrix.python-version }})
        run: poetry run pytest --cov=functional --cov-report=xml
        if: always()
      - name: mypy (Python v${{ matrix.python-version }})
        run: poetry run mypy functional
        if: always()
      - uses: codecov/codecov-action@v1
        with:
          file: ./coverage.xml

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
name: Python package
 
on:
  push:
    branches: [master, dev]
  pull_request:
    branches: [master]
 
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-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
        include:
          - python-version: "3.11"
            use_pandas: 1
    steps:
      - uses: actions/checkout@v3
      - run: pipx install poetry
      - uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
          cache: poetry
      - run: |
          if ! poetry install; then
            poetry lock
            poetry install
          fi
      - name: Pylint (Python v${{ matrix.python-version }})
        run: poetry run pylint functional
      - name: black (Python v${{ matrix.python-version }})
        run: poetry run black --diff --check functional
        if: always()
      - name: Test with pytest (Python v${{ matrix.python-version }})
        run: poetry run pytest --cov=functional --cov-report=xml
        if: always()
      - name: mypy (Python v${{ matrix.python-version }})
        run: poetry run mypy functional
        if: always()
      - uses: codecov/codecov-action@v1
        with:
          file: ./coverage.xml

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.
Add a job timeout so a hung step cannot burn hours of runner time.

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.

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.

Actions used in this workflow

actions/checkout actions/setup-python codecov/codecov-action