vcstool workflow (dirk-thomas/vcstool)

The vcstool workflow from dirk-thomas/vcstool, 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: dirk-thomas/vcstool.github/workflows/ci.ymlLicense Apache-2.0View source

What it does

This is the vcstool workflow from the dirk-thomas/vcstool 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: vcstool

on:
  push:
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  build:

    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest]
        python-version: [3.5, 3.6, 3.7, 3.8]
        include:
        - os: macos-latest
          python-version: 3.8
        - os: windows-latest
          python-version: 3.8

    steps:
    - uses: actions/checkout@v2
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v1
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip setuptools wheel
        python -m pip install --upgrade PyYAML
    - name: Install dependencies (macOS)
      run: |
        brew install subversion mercurial
      if: matrix.os == 'macos-latest'
    - name: Test with pytest
      run: |
        pip install --upgrade coverage flake8 flake8-docstrings flake8-import-order pytest
        git config --global --add init.defaultBranch master
        git config --global --add advice.detachedHead true
        ${{ matrix.os == 'windows-latest' && 'set PYTHONPATH=%cd% &&' || 'PYTHONPATH=`pwd`' }} pytest -s -v test

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: vcstool
 
on:
  push:
  pull_request:
    types: [opened, synchronize, reopened]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
 
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest]
        python-version: [3.5, 3.6, 3.7, 3.8]
        include:
        - os: macos-latest
          python-version: 3.8
        - os: windows-latest
          python-version: 3.8
 
    steps:
    - uses: actions/checkout@v2
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v1
      with:
        cache: 'pip'
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip setuptools wheel
        python -m pip install --upgrade PyYAML
    - name: Install dependencies (macOS)
      run: |
        brew install subversion mercurial
      if: matrix.os == 'macos-latest'
    - name: Test with pytest
      run: |
        pip install --upgrade coverage flake8 flake8-docstrings flake8-import-order pytest
        git config --global --add init.defaultBranch master
        git config --global --add advice.detachedHead true
        ${{ matrix.os == 'windows-latest' && 'set PYTHONPATH=%cd% &&' || 'PYTHONPATH=`pwd`' }} pytest -s -v test

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