Coverage check workflow (sanic-org/sanic)

The Coverage check workflow from sanic-org/sanic, explained and optimized by Latchkey.

What it does

This is the Coverage check workflow from the sanic-org/sanic 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

name: Coverage check
on:
  push:
    branches:
      - main
      - current-release
      - "*LTS"
    tags:
      - "!*" # Do not execute on tags
  pull_request:
    branches:
      - main
      - current-release
      - "*LTS"

jobs:
  coverage:
    name: Check coverage
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false

    steps:
      - name: Run coverage
        uses: sanic-org/simple-tox-action@v1
        with:
          python-version: "3.11"
          tox-env: coverage
          ignore-errors: true
      - name: Upload coverage artifact
        uses: actions/upload-artifact@v4
        with:
          name: coverage-report
          path: ./coverage.xml
          retention-days: 1
          if-no-files-found: error

The same workflow, on Latchkey

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

name: Coverage check
on:
  push:
    branches:
      - main
      - current-release
      - "*LTS"
    tags:
      - "!*" # Do not execute on tags
  pull_request:
    branches:
      - main
      - current-release
      - "*LTS"
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  coverage:
    timeout-minutes: 30
    name: Check coverage
    runs-on: latchkey-small
    strategy:
      fail-fast: false
 
    steps:
      - name: Run coverage
        uses: sanic-org/simple-tox-action@v1
        with:
          python-version: "3.11"
          tox-env: coverage
          ignore-errors: true
      - name: Upload coverage artifact
        uses: actions/upload-artifact@v4
        with:
          name: coverage-report
          path: ./coverage.xml
          retention-days: 1
          if-no-files-found: error
 

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.

This workflow runs 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow