dist-check workflow (automl/Auto-PyTorch)

The dist-check workflow from automl/Auto-PyTorch, explained and optimized by Latchkey.

CI health: D - needs work

Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: automl/Auto-PyTorch.github/workflows/dist.ymlLicense Apache-2.0View source

What it does

This is the dist-check workflow from the automl/Auto-PyTorch repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

workflow (.yml)

name: dist-check

on:
  # Manually triggerable in github
  workflow_dispatch:

  # When a push occurs on either of these branches
  push:
    branches:
      - master
      - development

  # When a push occurs on a PR that targets these branches
  pull_request:
    branches:
      - master
      - development

  schedule:
    # Every day at 7AM UTC
    - cron: '0 07 * * *'

jobs:

  dist:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout
      uses: actions/checkout@v2
      with:
        submodules: recursive
    - name: Setup Python
      uses: actions/setup-python@v2
      with:
        python-version: 3.8

    - name: Build dist
      run: |
        python setup.py sdist

    - name: Twine check
      run: |
        pip install twine
        last_dist=$(ls -t dist/autoPyTorch-*.tar.gz | head -n 1)
        twine check "$last_dist" --strict

    - name: Install dist
      run: |
        last_dist=$(ls -t dist/autoPyTorch-*.tar.gz | head -n 1)
        pip install $last_dist

    - name: PEP 561 Compliance
      run: |
        pip install mypy

        cd ..  # required to use the installed version of autoPyTorch

        # Note this doesn't perform mypy checks, those are handled in pre-commit.yaml
        # This only checks if autoPyTorch exports type information
        if ! mypy -c "import autoPyTorch"; then exit 1; fi

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: dist-check
 
on:
  # Manually triggerable in github
  workflow_dispatch:
 
  # When a push occurs on either of these branches
  push:
    branches:
      - master
      - development
 
  # When a push occurs on a PR that targets these branches
  pull_request:
    branches:
      - master
      - development
 
  schedule:
    # Every day at 7AM UTC
    - cron: '0 07 * * *'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
 
  dist:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    steps:
    - name: Checkout
      uses: actions/checkout@v2
      with:
        submodules: recursive
    - name: Setup Python
      uses: actions/setup-python@v2
      with:
        cache: 'pip'
        python-version: 3.8
 
    - name: Build dist
      run: |
        python setup.py sdist
 
    - name: Twine check
      run: |
        pip install twine
        last_dist=$(ls -t dist/autoPyTorch-*.tar.gz | head -n 1)
        twine check "$last_dist" --strict
 
    - name: Install dist
      run: |
        last_dist=$(ls -t dist/autoPyTorch-*.tar.gz | head -n 1)
        pip install $last_dist
 
    - name: PEP 561 Compliance
      run: |
        pip install mypy
 
        cd ..  # required to use the installed version of autoPyTorch
 
        # Note this doesn't perform mypy checks, those are handled in pre-commit.yaml
        # This only checks if autoPyTorch exports type information
        if ! mypy -c "import autoPyTorch"; then exit 1; fi

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.

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 per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow

actions/checkout actions/setup-python