CI workflow (SuperKogito/spafe)

The CI workflow from SuperKogito/spafe, 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.

Grade your own workflow free or run it on Latchkey →

Source: SuperKogito/spafe.github/workflows/ci.ymlLicense BSD-3-ClauseView source

What it does

This is the CI workflow from the SuperKogito/spafe repository, a real project running GitHub Actions. It is shown here with attribution under its BSD-3-Clause license.

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

The workflow

workflow (.yml)

name: CI

on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master

jobs:
  # paper:
  #   runs-on: ubuntu-latest
  #   name: Paper Draft
  #   steps:
  #     - name: Checkout
  #       uses: actions/checkout@v2
      
  #     # This step builds a draft PDF of the paper using the Open Journals draft action.
  #     - name: Build draft PDF
  #       uses: openjournals/openjournals-draft-action@master
  #       with:
  #         journal: joss  # Specifies the journal format (e.g., JOSS).
  #         # Path to the paper markdown file within the repository.
  #         paper-path: paper/paper.md

  #     # This step uploads the generated PDF as an artifact for later access.
  #     - name: Upload
  #       uses: actions/upload-artifact@v1
  #       with:
  #         name: paper  # Artifact name.
  #         # Path to the generated paper PDF file.
  #         path: paper/paper.pdf
          
  formatting:
    # needs: paper  # Removed dependency on the paper job
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      - name: Setup python
        uses: actions/setup-python@v2
        with:
          python-version: "3.10"

      - name: Setup black environment
        run: |
          pip install --upgrade pip
          pip install black

      - name: Check formatting with black
        run: |
          black --check spafe

  testing:
    needs: formatting
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.8", "3.9", "3.10"]

    steps:
      - uses: actions/checkout@v2

      - name: Setup python
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}

      - name: Setup testing environment
        run: |
          pip install --upgrade pip
          pip install .[tests]

      - name: Test
        run: |
          pytest -x --cache-clear -n 8 -q --cov=./ || --force-yes
          codecov

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:
      - master
  pull_request:
    branches:
      - master
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  # paper:
  #   runs-on: latchkey-small
  #   name: Paper Draft
  #   steps:
  #     - name: Checkout
  #       uses: actions/checkout@v2
      
  #     # This step builds a draft PDF of the paper using the Open Journals draft action.
  #     - name: Build draft PDF
  #       uses: openjournals/openjournals-draft-action@master
  #       with:
  #         journal: joss  # Specifies the journal format (e.g., JOSS).
  #         # Path to the paper markdown file within the repository.
  #         paper-path: paper/paper.md
 
  #     # This step uploads the generated PDF as an artifact for later access.
  #     - name: Upload
  #       uses: actions/upload-artifact@v1
  #       with:
  #         name: paper  # Artifact name.
  #         # Path to the generated paper PDF file.
  #         path: paper/paper.pdf
          
  formatting:
    timeout-minutes: 30
    # needs: paper  # Removed dependency on the paper job
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v2
 
      - name: Setup python
        uses: actions/setup-python@v2
        with:
          cache: 'pip'
          python-version: "3.10"
 
      - name: Setup black environment
        run: |
          pip install --upgrade pip
          pip install black
 
      - name: Check formatting with black
        run: |
          black --check spafe
 
  testing:
    timeout-minutes: 30
    needs: formatting
    runs-on: latchkey-small
    strategy:
      matrix:
        python-version: ["3.8", "3.9", "3.10"]
 
    steps:
      - uses: actions/checkout@v2
 
      - name: Setup python
        uses: actions/setup-python@v2
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
 
      - name: Setup testing environment
        run: |
          pip install --upgrade pip
          pip install .[tests]
 
      - name: Test
        run: |
          pytest -x --cache-clear -n 8 -q --cov=./ || --force-yes
          codecov

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.

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 2 jobs (4 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/upload-artifact actions/setup-python