website workflow (mdx-js/mdx)

The website workflow from mdx-js/mdx, explained and optimized by Latchkey.

What it does

This is the website workflow from the mdx-js/mdx 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

jobs:
  deploy:
    environment:
      name: Website
      url: ${{steps.deployment.outputs.page_url}}
    permissions:
      contents: read
      id-token: write
      pages: write
    # To do: replace w/ `ubuntu-latest` when upstream is solved:
    # <https://github.com/puppeteer/puppeteer/issues/12818>.
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-node@v6
        with:
          node-version: lts/*
      - run: npm ci
      - run: npx puppeteer browsers install chrome
      - run: npm run docs
      - uses: actions/upload-pages-artifact@v5
        with:
          path: public
      - uses: actions/deploy-pages@v5
        id: deployment
name: website
on:
  push:
    branches:
      - main

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.

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  deploy:
    timeout-minutes: 30
    environment:
      name: Website
      url: ${{steps.deployment.outputs.page_url}}
    permissions:
      contents: read
      id-token: write
      pages: write
    # To do: replace w/ `ubuntu-latest` when upstream is solved:
    # <https://github.com/puppeteer/puppeteer/issues/12818>.
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-node@v6
        with:
          cache: 'npm'
          node-version: lts/*
      - run: npm ci
      - run: npx puppeteer browsers install chrome
      - run: npm run docs
      - uses: actions/upload-pages-artifact@v5
        with:
          path: public
      - uses: actions/deploy-pages@v5
        id: deployment
name: website
on:
  push:
    branches:
      - main
 

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
• End-to-end and browser tests

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