Deploy Website workflow (openlayers/openlayers)

The Deploy Website workflow from openlayers/openlayers, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get caching, 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: openlayers/openlayers.github/workflows/deploy.ymlLicense BSD-2-ClauseView source

What it does

This is the Deploy Website workflow from the openlayers/openlayers repository, a real project running GitHub Actions. It is shown here with attribution under its BSD-2-Clause license.

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

The workflow

workflow (.yml)

name: Deploy Website

on:
  push:
    branches:
      - main
    tags:
      - 'v*.*.*'

concurrency:
  group: "deploy"

jobs:
  deploy-branch:
    if: startsWith(github.ref, 'refs/heads/')
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7.0.0
      - uses: actions/setup-node@v6
        with:
          node-version: '24'
      - name: Install dependencies
        run: npm ci
      - name: Build Website
        run: ./tasks/build-website.sh -l $(node tasks/get-latest-release.js)
      - name: Check out openlayers.github.io
        uses: actions/checkout@v7.0.0
        with:
          repository: openlayers/openlayers.github.io
          ssh-key: ${{ secrets.OPENLAYERS_GITHUB_IO_KEY }}
          path: openlayers.github.io
      - run: |
          cp -r build/site/* openlayers.github.io/dist/
          cd openlayers.github.io
          if [ -n "$(git status --porcelain)" ]; then
            git config user.name "$(git --no-pager log --format=format:'%an' -n 1)"
            git config user.email "$(git --no-pager log --format=format:'%ae' -n 1)"
            git add .
            git commit -m "Website updates"
            git push origin main
          fi
  deploy-tag:
    if: startsWith(github.ref, 'refs/tags/')
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7.0.0
      - uses: actions/setup-node@v6
        with:
          node-version: '24'
      - name: Install dependencies
        run: npm ci
      - name: Assert Latest Release
        run: node tasks/newest-tag.js --tag ${GITHUB_REF_NAME}
      - name: Build Website
        run: ./tasks/build-website.sh -l ${GITHUB_REF_NAME} -v ${GITHUB_REF_NAME}
      - name: Check out openlayers.github.io
        uses: actions/checkout@v7.0.0
        with:
          repository: openlayers/openlayers.github.io
          ssh-key: ${{ secrets.OPENLAYERS_GITHUB_IO_KEY }}
          path: openlayers.github.io
      - run: |
          cp -r build/site/* openlayers.github.io/dist/
          cd openlayers.github.io
          if [ -n "$(git status --porcelain)" ]; then
            git config user.name "$(git --no-pager log --format=format:'%an' -n 1)"
            git config user.email "$(git --no-pager log --format=format:'%ae' -n 1)"
            git add .
            git commit -m "Website updates"
            git push origin main
          fi

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 Website
 
on:
  push:
    branches:
      - main
    tags:
      - 'v*.*.*'
 
concurrency:
  group: "deploy"
 
jobs:
  deploy-branch:
    timeout-minutes: 30
    if: startsWith(github.ref, 'refs/heads/')
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v7.0.0
      - uses: actions/setup-node@v6
        with:
          cache: 'npm'
          node-version: '24'
      - name: Install dependencies
        run: npm ci
      - name: Build Website
        run: ./tasks/build-website.sh -l $(node tasks/get-latest-release.js)
      - name: Check out openlayers.github.io
        uses: actions/checkout@v7.0.0
        with:
          repository: openlayers/openlayers.github.io
          ssh-key: ${{ secrets.OPENLAYERS_GITHUB_IO_KEY }}
          path: openlayers.github.io
      - run: |
          cp -r build/site/* openlayers.github.io/dist/
          cd openlayers.github.io
          if [ -n "$(git status --porcelain)" ]; then
            git config user.name "$(git --no-pager log --format=format:'%an' -n 1)"
            git config user.email "$(git --no-pager log --format=format:'%ae' -n 1)"
            git add .
            git commit -m "Website updates"
            git push origin main
          fi
  deploy-tag:
    timeout-minutes: 30
    if: startsWith(github.ref, 'refs/tags/')
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v7.0.0
      - uses: actions/setup-node@v6
        with:
          cache: 'npm'
          node-version: '24'
      - name: Install dependencies
        run: npm ci
      - name: Assert Latest Release
        run: node tasks/newest-tag.js --tag ${GITHUB_REF_NAME}
      - name: Build Website
        run: ./tasks/build-website.sh -l ${GITHUB_REF_NAME} -v ${GITHUB_REF_NAME}
      - name: Check out openlayers.github.io
        uses: actions/checkout@v7.0.0
        with:
          repository: openlayers/openlayers.github.io
          ssh-key: ${{ secrets.OPENLAYERS_GITHUB_IO_KEY }}
          path: openlayers.github.io
      - run: |
          cp -r build/site/* openlayers.github.io/dist/
          cd openlayers.github.io
          if [ -n "$(git status --porcelain)" ]; then
            git config user.name "$(git --no-pager log --format=format:'%an' -n 1)"
            git config user.email "$(git --no-pager log --format=format:'%ae' -n 1)"
            git add .
            git commit -m "Website updates"
            git push origin main
          fi

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 2 jobs 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