Test Black workflow (D-X-Y/Awesome-AutoDL)

The Test Black workflow from D-X-Y/Awesome-AutoDL, explained and optimized by Latchkey.

CI health: D - needs work

Run this on Latchkey for self-healing, caching, and up to 58% lower cost.

Grade your own workflow free or run it on Latchkey →

Source: D-X-Y/Awesome-AutoDL.github/workflows/test-basic.ymlLicense MITView source

What it does

This is the Test Black workflow from the D-X-Y/Awesome-AutoDL 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

workflow (.yml)

name: Test Black
on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main


jobs:
  build:
    strategy:
      matrix:
        os: [ubuntu-18.04, ubuntu-20.04, macos-latest]
        python-version: [3.6, 3.7, 3.8, 3.9]

    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v2

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}

      - name: Lint with Black
        run: |
          python -m pip install --upgrade pip
          python -m pip install black
          python --version
          python -m black --version
          echo $PWD ; ls
          python -m black ./awesome_autodl/bins/* -l 88 --check --diff --verbose
          python -m black ./awesome_autodl/utils/* -l 88 --check --diff --verbose

      - name: Install Awesome-AutoDL from source
        run: |
          python -m pip install . --force

      - name: Run tests with pytest
        run: |
          python -m pip install pytest
          python -m pytest . --durations=0

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: Test Black
on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
 
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    strategy:
      matrix:
        os: [ubuntu-18.04, ubuntu-20.04, macos-latest]
        python-version: [3.6, 3.7, 3.8, 3.9]
 
    runs-on: ${{ matrix.os }}
    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: Lint with Black
        run: |
          python -m pip install --upgrade pip
          python -m pip install black
          python --version
          python -m black --version
          echo $PWD ; ls
          python -m black ./awesome_autodl/bins/* -l 88 --check --diff --verbose
          python -m black ./awesome_autodl/utils/* -l 88 --check --diff --verbose
 
      - name: Install Awesome-AutoDL from source
        run: |
          python -m pip install . --force
 
      - name: Run tests with pytest
        run: |
          python -m pip install pytest
          python -m pytest . --durations=0

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

actions/checkout actions/setup-python