Docs workflow (automl/Auto-PyTorch)

The Docs 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/docs.ymlLicense Apache-2.0View source

What it does

This is the Docs 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: Docs

on:
  # Allow to manually trigger through github API
  # Wont trigger the push to github pages where the documentation is located
  workflow_dispatch:

  # Triggers with push to these branches
  push:
    branches:
      - master
      - development

  # Triggers with push to a pr aimed at these branches
  pull_request:
    branches:
      - master
      - development

jobs:
  build-and-deploy:
    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: Install dependencies
      run: |
        pip install -e .[docs,examples,forecasting]

    - name: Make docs
      run: |
        cd docs
        make html

    - name: Pull latest gh-pages
      if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
      run: |
        cd ..
        git clone https://github.com/automl/Auto-PyTorch.git --branch gh-pages --single-branch gh-pages

    - name: Copy new doc into gh-pages
      if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
      run: |
        branch_name=${GITHUB_REF##*/}
        cd ../gh-pages
        rm -rf $branch_name
        cp -r ../Auto-PyTorch/docs/build/html $branch_name

    - name: Push to gh-pages
      if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
      run: |
        last_commit=$(git log --pretty=format:"%an: %s")
        cd ../gh-pages
        branch_name=${GITHUB_REF##*/}
        git add $branch_name/
        git config --global user.name 'Github Actions'
        git config --global user.email 'not@mail.com'
        git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
        git commit -am "$last_commit"
        git push

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: Docs
 
on:
  # Allow to manually trigger through github API
  # Wont trigger the push to github pages where the documentation is located
  workflow_dispatch:
 
  # Triggers with push to these branches
  push:
    branches:
      - master
      - development
 
  # Triggers with push to a pr aimed at these branches
  pull_request:
    branches:
      - master
      - development
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build-and-deploy:
    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: Install dependencies
      run: |
        pip install -e .[docs,examples,forecasting]
 
    - name: Make docs
      run: |
        cd docs
        make html
 
    - name: Pull latest gh-pages
      if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
      run: |
        cd ..
        git clone https://github.com/automl/Auto-PyTorch.git --branch gh-pages --single-branch gh-pages
 
    - name: Copy new doc into gh-pages
      if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
      run: |
        branch_name=${GITHUB_REF##*/}
        cd ../gh-pages
        rm -rf $branch_name
        cp -r ../Auto-PyTorch/docs/build/html $branch_name
 
    - name: Push to gh-pages
      if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
      run: |
        last_commit=$(git log --pretty=format:"%an: %s")
        cd ../gh-pages
        branch_name=${GITHUB_REF##*/}
        git add $branch_name/
        git config --global user.name 'Github Actions'
        git config --global user.email 'not@mail.com'
        git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
        git commit -am "$last_commit"
        git push

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