CI workflow (sepandhaghighi/art)

The CI workflow from sepandhaghighi/art, explained and optimized by Latchkey.

CI health: F - at risk

Run this on Latchkey for self-healing, caching, and up to 58% lower cost.

Grade your own workflow free or run it on Latchkey →

Source: sepandhaghighi/art.github/workflows/test.ymlLicense MITView source

What it does

This is the CI workflow from the sepandhaghighi/art 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: CI

on:
  push:
    branches:
      - master
      - dev

  pull_request:
    branches:
      - master
      - dev

env:
  TEST_PYTHON_VERSION: 3.9
  TEST_OS: 'ubuntu-22.04'

jobs:
  build:

    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-22.04, windows-2022, macOS-13]
        python-version: [3.7, 3.8, 3.9, 3.10.5, 3.11.0, 3.12.0, 3.13.0]
    steps:
    - uses: actions/checkout@v2
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        python-version: ${{ matrix.python-version }}
    - name: Installation
      run: |
        python -m pip install --upgrade pip
        pip install .
    - name: First test
      run: |
        art
        art test
        art test2
    - name: Test requirements installation
      run: |
        pip install --upgrade --upgrade-strategy=only-if-needed -r dev-requirements.txt
    - name: Version check
      run: |
        python otherfile/version_check.py
      if: matrix.python-version == env.TEST_PYTHON_VERSION
    - name: Font check
      run: |
        python otherfile/font_check.py
    - name: ART-Decor check
      run: |
        python otherfile/art_decor_check.py
    - name: Notebook check
      run: |
        pip install notebook>=5.2.2
        python otherfile/notebook_check.py
      if: matrix.python-version == env.TEST_PYTHON_VERSION && matrix.os == env.TEST_OS
    - name: Other tests
      run: |
        python -m vulture art/ otherfile/ setup.py art_profile.py --min-confidence 65 --exclude=__init__.py --sort-by-size
        python -m bandit -r art -s B311
        python -m pydocstyle --match='(?!test).*\.py' -v
      if: matrix.python-version == env.TEST_PYTHON_VERSION
    - name: Coverage
      run: |
        coverage run -m art test2
      if: matrix.python-version == env.TEST_PYTHON_VERSION && matrix.os == env.TEST_OS
    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@v3
      with:
          fail_ci_if_error: false
      if: matrix.python-version == env.TEST_PYTHON_VERSION && matrix.os == env.TEST_OS
    - name: Profile
      run: |
        python -m cProfile -s cumtime art_profile.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.

# 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: CI
 
on:
  push:
    branches:
      - master
      - dev
 
  pull_request:
    branches:
      - master
      - dev
 
env:
  TEST_PYTHON_VERSION: 3.9
  TEST_OS: 'ubuntu-22.04'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
 
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-22.04, windows-2022, macOS-13]
        python-version: [3.7, 3.8, 3.9, 3.10.5, 3.11.0, 3.12.0, 3.13.0]
    steps:
    - uses: actions/checkout@v2
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        cache: 'pip'
        python-version: ${{ matrix.python-version }}
    - name: Installation
      run: |
        python -m pip install --upgrade pip
        pip install .
    - name: First test
      run: |
        art
        art test
        art test2
    - name: Test requirements installation
      run: |
        pip install --upgrade --upgrade-strategy=only-if-needed -r dev-requirements.txt
    - name: Version check
      run: |
        python otherfile/version_check.py
      if: matrix.python-version == env.TEST_PYTHON_VERSION
    - name: Font check
      run: |
        python otherfile/font_check.py
    - name: ART-Decor check
      run: |
        python otherfile/art_decor_check.py
    - name: Notebook check
      run: |
        pip install notebook>=5.2.2
        python otherfile/notebook_check.py
      if: matrix.python-version == env.TEST_PYTHON_VERSION && matrix.os == env.TEST_OS
    - name: Other tests
      run: |
        python -m vulture art/ otherfile/ setup.py art_profile.py --min-confidence 65 --exclude=__init__.py --sort-by-size
        python -m bandit -r art -s B311
        python -m pydocstyle --match='(?!test).*\.py' -v
      if: matrix.python-version == env.TEST_PYTHON_VERSION
    - name: Coverage
      run: |
        coverage run -m art test2
      if: matrix.python-version == env.TEST_PYTHON_VERSION && matrix.os == env.TEST_OS
    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@v3
      with:
          fail_ci_if_error: false
      if: matrix.python-version == env.TEST_PYTHON_VERSION && matrix.os == env.TEST_OS
    - name: Profile
      run: |
        python -m cProfile -s cumtime art_profile.py

What changed

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.

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 (21 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