Build workflow (ESA-PhiLab/OpenSarToolkit)

The Build workflow from ESA-PhiLab/OpenSarToolkit, explained and optimized by Latchkey.

What it does

This is the Build workflow from the ESA-PhiLab/OpenSarToolkit 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: Build

on: 
  - push
  - workflow_dispatch

env:
  GPT_PATH: /usr/bin/gpt

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: [3.7, 3.8]

    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install GDAL
        run: |
          sudo add-apt-repository ppa:ubuntugis/ppa && sudo apt-get update
          sudo apt-get update
          sudo apt-get install gdal-bin
          sudo apt-get install libgdal-dev
          export CPLUS_INCLUDE_PATH=/usr/include/gdal
          export C_INCLUDE_PATH=/usr/include/gdal
          pip install GDAL==3.2.3
      - name: Install dependencies
        run: pip install .[dev]
      - name: Test formatting
        uses: psf/black@stable
      - name: PEP8 rules
        uses: tonybajan/flake8-check-action@v1.0.0
        with:
            repotoken: ${{ secrets.GITHUB_TOKEN }}
      - name: test with pytest
        run: coverage run -m pytest --color=yes tests
      - name: coverage
        run: coverage report -m
      - name: codecov
        run: bash <(curl -s https://codecov.io/bash)

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: Build
 
on: 
  - push
  - workflow_dispatch
 
env:
  GPT_PATH: /usr/bin/gpt
 
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.7, 3.8]
 
    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: Install GDAL
        run: |
          sudo add-apt-repository ppa:ubuntugis/ppa && sudo apt-get update
          sudo apt-get update
          sudo apt-get install gdal-bin
          sudo apt-get install libgdal-dev
          export CPLUS_INCLUDE_PATH=/usr/include/gdal
          export C_INCLUDE_PATH=/usr/include/gdal
          pip install GDAL==3.2.3
      - name: Install dependencies
        run: pip install .[dev]
      - name: Test formatting
        uses: psf/black@stable
      - name: PEP8 rules
        uses: tonybajan/flake8-check-action@v1.0.0
        with:
            repotoken: ${{ secrets.GITHUB_TOKEN }}
      - name: test with pytest
        run: coverage run -m pytest --color=yes tests
      - name: coverage
        run: coverage report -m
      - name: codecov
        run: bash <(curl -s https://codecov.io/bash)
 

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.

2 third-party actions are referenced by a movable tag. Pin them 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 (2 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