Tests workflow (egerber/spaCy-entity-linker)

The Tests workflow from egerber/spaCy-entity-linker, explained and optimized by Latchkey.

What it does

This is the Tests workflow from the egerber/spaCy-entity-linker 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:
    branches: [ master ]
  pull_request:
    branches: [ master ]
jobs:
  test:
    name: Run tests
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [ "3.7", "3.8", "3.9", "3.10", "3.11" ]
    steps:
    - uses: actions/checkout@v3
    - name: python ${{ matrix.python-version }} 
      uses: actions/setup-python@v4
      with:
        python-version: ${{ matrix.python-version }} 
        cache: 'pip' # caching pip dependencies
    - name: Install Python dependencies
      uses: py-actions/py-dependency-install@v4
    - name: Install additional for testing
      run: ./.github/scripts/tests-setup.sh
      shell: bash
    - name: Run the tests
      run: ./.github/scripts/run-tests.sh
      shell: bash

The same workflow, on Latchkey

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

name: Tests
on: 
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  test:
    timeout-minutes: 30
    name: Run tests
    runs-on: latchkey-small
    strategy:
      matrix:
        python-version: [ "3.7", "3.8", "3.9", "3.10", "3.11" ]
    steps:
    - uses: actions/checkout@v3
    - name: python ${{ matrix.python-version }} 
      uses: actions/setup-python@v4
      with:
        python-version: ${{ matrix.python-version }} 
        cache: 'pip' # caching pip dependencies
    - name: Install Python dependencies
      uses: py-actions/py-dependency-install@v4
    - name: Install additional for testing
      run: ./.github/scripts/tests-setup.sh
      shell: bash
    - name: Run the tests
      run: ./.github/scripts/run-tests.sh
      shell: 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.
• 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 (5 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