Deploy workflow (react/metro)

The Deploy workflow from react/metro, 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: react/metro.github/workflows/deploy-website.ymlLicense MITView source

What it does

This is the Deploy workflow from the react/metro 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

workflow (.yml)

name: Deploy

on:
  push:
    branches:
      - "main"
    paths:
      - "docs/**"
      - "website/**"
      - ".github/workflows/deploy-website.yml"

permissions:
  contents: read

jobs:
  deploy:
    permissions:
      contents: write # to deploy
    runs-on: ubuntu-latest

    if: github.repository == 'facebook/metro'

    env:
      working-directory: website
      node-version: lts/*

    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Use Node.js ${{ env.node-version }}
        uses: actions/setup-node@v6
        with:
          node-version: ${{ env.node-version }}

      - name: Get yarn cache directory
        id: yarn
        run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT

      - name: Restore yarn cache
        uses: actions/cache@v5
        with:
          path: ${{ steps.yarn.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles(format('{0}{1}', github.workspace, '/website/yarn.lock')) }}

      - name: Install packages
        working-directory: ${{ env.working-directory }}
        run: yarn --frozen-lockfile

      - name: Deploy to GitHub Pages
        working-directory: ${{ env.working-directory }}
        run: |
          git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
          git config --global user.name "${GITHUB_ACTOR}"
          echo "machine github.com login ${GITHUB_ACTOR} password ${{ secrets.GITHUB_TOKEN }}" > ~/.netrc
          GIT_USER=${GITHUB_ACTOR} yarn deploy

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: Deploy
 
on:
  push:
    branches:
      - "main"
    paths:
      - "docs/**"
      - "website/**"
      - ".github/workflows/deploy-website.yml"
 
permissions:
  contents: read
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  deploy:
    timeout-minutes: 30
    permissions:
      contents: write # to deploy
    runs-on: latchkey-small
 
    if: github.repository == 'facebook/metro'
 
    env:
      working-directory: website
      node-version: lts/*
 
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
 
      - name: Use Node.js ${{ env.node-version }}
        uses: actions/setup-node@v6
        with:
          cache: 'npm'
          node-version: ${{ env.node-version }}
 
      - name: Get yarn cache directory
        id: yarn
        run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
 
      - name: Restore yarn cache
        uses: actions/cache@v5
        with:
          path: ${{ steps.yarn.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles(format('{0}{1}', github.workspace, '/website/yarn.lock')) }}
 
      - name: Install packages
        working-directory: ${{ env.working-directory }}
        run: yarn --frozen-lockfile
 
      - name: Deploy to GitHub Pages
        working-directory: ${{ env.working-directory }}
        run: |
          git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
          git config --global user.name "${GITHUB_ACTOR}"
          echo "machine github.com login ${GITHUB_ACTOR} password ${{ secrets.GITHUB_TOKEN }}" > ~/.netrc
          GIT_USER=${GITHUB_ACTOR} yarn deploy

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-node actions/cache