Guide workflow (bethgelab/foolbox)

The Guide workflow from bethgelab/foolbox, explained and optimized by Latchkey.

What it does

This is the Guide workflow from the bethgelab/foolbox 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

name: Guide

on:
  push:
    branches:
      - master

jobs:
  vuepress:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Install vuepress
      run: |
        sudo apt update
        sudo apt install yarn -y
        yarn global add vuepress
        yarn add vue-template-compiler
    - name: Build
      run: |
        export NODE_OPTIONS=--openssl-legacy-provider
        vuepress build
      working-directory: ./guide
    - name: Push
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      run: |
        git init
        git config user.name "GitHub Actions Bot"
        git config user.email "<>"
        git add -A
        git commit -m 'deploy'
        git push -f https://x-access-token:${GITHUB_TOKEN}@github.com/bethgelab/foolbox.git master:gh-pages
      working-directory: ./guide/.vuepress/dist

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

name: Guide
 
on:
  push:
    branches:
      - master
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  vuepress:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
    - uses: actions/checkout@v2
    - name: Install vuepress
      run: |
        sudo apt update
        sudo apt install yarn -y
        yarn global add vuepress
        yarn add vue-template-compiler
    - name: Build
      run: |
        export NODE_OPTIONS=--openssl-legacy-provider
        vuepress build
      working-directory: ./guide
    - name: Push
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      run: |
        git init
        git config user.name "GitHub Actions Bot"
        git config user.email "<>"
        git add -A
        git commit -m 'deploy'
        git push -f https://x-access-token:${GITHUB_TOKEN}@github.com/bethgelab/foolbox.git master:gh-pages
      working-directory: ./guide/.vuepress/dist
 

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.
• 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