Deploy static content to Pages workflow (tryolabs/norfair)

The Deploy static content to Pages workflow from tryolabs/norfair, explained and optimized by Latchkey.

What it does

This is the Deploy static content to Pages workflow from the tryolabs/norfair repository, a real project running GitHub Actions. It is shown here with attribution under its BSD-3-Clause license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["master"]
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Allow one concurrent deployment
concurrency:
  group: "docs"
  cancel-in-progress: true

jobs:
  # Single deploy job since we're just deploying
  deploy:
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Set up Python 3.8
        uses: actions/setup-python@v4
        with:
          python-version: "3.8"
      - name: Setup a user for the commits
        run: |
          git config user.name ci-bot 
          git config user.email ci-bot@tryolabs.com
      - name: Installing dependencies
        run: pip install -r docs/requirements.txt
      - name: Updating "dev"
        run: mike deploy --push dev
      

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.

# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages
 
on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["master"]
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:
 
# Allow one concurrent deployment
concurrency:
  group: "docs"
  cancel-in-progress: true
 
jobs:
  # Single deploy job since we're just deploying
  deploy:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Set up Python 3.8
        uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: "3.8"
      - name: Setup a user for the commits
        run: |
          git config user.name ci-bot 
          git config user.email ci-bot@tryolabs.com
      - name: Installing dependencies
        run: pip install -r docs/requirements.txt
      - name: Updating "dev"
        run: mike deploy --push dev
      
 

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