Unittest workflow (tangyoha/telegram_media_downloader)

The Unittest workflow from tangyoha/telegram_media_downloader, explained and optimized by Latchkey.

What it does

This is the Unittest workflow from the tangyoha/telegram_media_downloader 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: Unittest

on:
  push:
    branches: [ master ]
    paths-ignore:
      - 'README.md'
  pull_request:
    branches: [ master ]
    paths-ignore:
      - 'README.md'

jobs:
  build:

    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest]
        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12' ]
    name: Test - Python ${{ matrix.python-version }} on ${{ matrix.os }}

    steps:
    - uses: actions/checkout@v3
    - name: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: ${{ matrix.python-version }}
    - name: Get setuptools Unix
      if: ${{ matrix.os != 'windows-latest' }}
      run: python -m pip install --upgrade pip setuptools codecov
    - name: Get setuptools Windows
      if: ${{ matrix.os == 'windows-latest' }}
      run: python -m pip install --upgrade pip setuptools codecov
    - name: Install dependencies
      run: make dev_install
    - name: Test with pytest
      run: |
        make -e test
        codecov
      env:
        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

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: Unittest
 
on:
  push:
    branches: [ master ]
    paths-ignore:
      - 'README.md'
  pull_request:
    branches: [ master ]
    paths-ignore:
      - 'README.md'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
 
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest]
        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12' ]
    name: Test - Python ${{ matrix.python-version }} on ${{ matrix.os }}
 
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python
      uses: actions/setup-python@v4
      with:
        cache: 'pip'
        python-version: ${{ matrix.python-version }}
    - name: Get setuptools Unix
      if: ${{ matrix.os != 'windows-latest' }}
      run: python -m pip install --upgrade pip setuptools codecov
    - name: Get setuptools Windows
      if: ${{ matrix.os == 'windows-latest' }}
      run: python -m pip install --upgrade pip setuptools codecov
    - name: Install dependencies
      run: make dev_install
    - name: Test with pytest
      run: |
        make -e test
        codecov
      env:
        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 

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