Deploy to gh-pages workflow (NVIDIA/NVFlare)

The Deploy to gh-pages workflow from NVIDIA/NVFlare, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get run de-duplication, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: NVIDIA/NVFlare.github/workflows/deploy.ymlLicense Apache-2.0View source

What it does

This is the Deploy to gh-pages workflow from the NVIDIA/NVFlare repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

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

The workflow

workflow (.yml)

name: Deploy to gh-pages

on:
  # Trigger the workflow if any web/** files are modified
  push:
    branches:
      - "main"
      - "2.5"
      - "2.6"
    paths:
      - 'web/**'
  workflow_dispatch:

env:
  site_path: ./web
  version_path: /

# Allow this job to clone the repo and create a page deployment
permissions:
  contents: write
  pages: write
  id-token: write

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Update version_path for non-main branches
        if: ${{ github.ref_type == 'branch' && github.ref_name != 'main'}}
        run: echo version_path=/version/${{ github.ref_name }}/ >> $GITHUB_ENV

      - name: Checkout your repository
        uses: NVIDIA/spark-rapids-common/checkout@main

      - name: Setup Node
        uses: actions/setup-node@v5
        with:
          node-version: '22.12'
          cache: npm
          cache-dependency-path: "${{ env.site_path }}/package-lock.json"

      - name: Install dependencies
        run: npm install
        working-directory: ${{ env.site_path }}

      - name: Build project
        run: npm run build
        env:
          VITE_PUBLIC_GH_BRANCH: ${{ github.ref_name }}
        working-directory: ${{ env.site_path }}

      - name: Deploy
        uses: JamesIves/github-pages-deploy-action@v4.8.0
        with:
          branch: gh-pages
          folder: ${{ env.site_path }}/dist
          target-folder: ${{ env.version_path }}
          clean-exclude: version

The same workflow, on Latchkey

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

name: Deploy to gh-pages
 
on:
  # Trigger the workflow if any web/** files are modified
  push:
    branches:
      - "main"
      - "2.5"
      - "2.6"
    paths:
      - 'web/**'
  workflow_dispatch:
 
env:
  site_path: ./web
  version_path: /
 
# Allow this job to clone the repo and create a page deployment
permissions:
  contents: write
  pages: write
  id-token: write
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - name: Update version_path for non-main branches
        if: ${{ github.ref_type == 'branch' && github.ref_name != 'main'}}
        run: echo version_path=/version/${{ github.ref_name }}/ >> $GITHUB_ENV
 
      - name: Checkout your repository
        uses: NVIDIA/spark-rapids-common/checkout@main
 
      - name: Setup Node
        uses: actions/setup-node@v5
        with:
          node-version: '22.12'
          cache: npm
          cache-dependency-path: "${{ env.site_path }}/package-lock.json"
 
      - name: Install dependencies
        run: npm install
        working-directory: ${{ env.site_path }}
 
      - name: Build project
        run: npm run build
        env:
          VITE_PUBLIC_GH_BRANCH: ${{ github.ref_name }}
        working-directory: ${{ env.site_path }}
 
      - name: Deploy
        uses: JamesIves/github-pages-deploy-action@v4.8.0
        with:
          branch: gh-pages
          folder: ${{ env.site_path }}/dist
          target-folder: ${{ env.version_path }}
          clean-exclude: version

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.

2 third-party actions are referenced by a movable tag. Pin them to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.

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/setup-node