Documentation workflow (PyGCL/PyGCL)

The Documentation workflow from PyGCL/PyGCL, explained and optimized by Latchkey.

What it does

This is the Documentation workflow from the PyGCL/PyGCL 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

name: Documentation

on: [push, pull_request]

jobs:
  make-documentation:
    runs-on: ${{ matrix.os }}

    strategy:
      matrix:
        os: [ ubuntu-20.04 ]
        python-version: [ 3.9 ]
        torch-version: [ 1.9.0 ]

    steps:
      - uses: actions/checkout@main
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install internal dependencies
        run: |
          cd docs && pip install --requirement requirements_docs.txt
      - name: Install main package
        run: |
          pip install -e .
      - name: Build documentation
        run: |
          cd docs && make clean && make html SPHINXOPTS="-W"

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: Documentation
 
on: [push, pull_request]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  make-documentation:
    timeout-minutes: 30
    runs-on: ${{ matrix.os }}
 
    strategy:
      matrix:
        os: [ ubuntu-20.04 ]
        python-version: [ 3.9 ]
        torch-version: [ 1.9.0 ]
 
    steps:
      - uses: actions/checkout@main
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
      - name: Install internal dependencies
        run: |
          cd docs && pip install --requirement requirements_docs.txt
      - name: Install main package
        run: |
          pip install -e .
      - name: Build documentation
        run: |
          cd docs && make clean && make html SPHINXOPTS="-W"
 

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

Actions used in this workflow