tests workflow (awesome-spectral-indices/spyndex)

The tests workflow from awesome-spectral-indices/spyndex, explained and optimized by Latchkey.

What it does

This is the tests workflow from the awesome-spectral-indices/spyndex 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: tests

on: [push, pull_request]

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        python-version: [3.9]
        os: [ubuntu-latest, macOS-latest, windows-latest]
    steps:
      - name: checkout
        uses: actions/checkout@v2
      - name: python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - name: dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install --upgrade tox
      - name: execute        
        run: |
          python ./.github/scripts/update_ee_token.py
        env:
          EE_TOKEN: ${{ secrets.EE_TOKEN }}
      - name: tests
        run: |
          tox -e 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.

name: tests
 
on: [push, pull_request]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        python-version: [3.9]
        os: [ubuntu-latest, macOS-latest, windows-latest]
    steps:
      - name: checkout
        uses: actions/checkout@v2
      - name: python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
      - name: dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install --upgrade tox
      - name: execute        
        run: |
          python ./.github/scripts/update_ee_token.py
        env:
          EE_TOKEN: ${{ secrets.EE_TOKEN }}
      - name: tests
        run: |
          tox -e 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.

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