Documentation Deployment workflow (select2/select2)

The Documentation Deployment workflow from select2/select2, explained and optimized by Latchkey.

What it does

This is the Documentation Deployment workflow from the select2/select2 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

name: Documentation Deployment
on:
  release:
    types: [published]
  workflow_dispatch:
permissions:
  contents: write
jobs:
  gh-page-build:
    runs-on: ubuntu-latest
    if: github.event_name != 'release' || github.event.release.prerelease == false
    steps:
      - uses: actions/checkout@v7
        with:
          fetch-depth: 0
      - uses: astral-sh/setup-uv@v7
      - run: uv run mkdocs build
        env:
          MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }}
      - uses: actions/upload-pages-artifact@v5
        with:
          path: site
  gh-page-deploy:
    needs: gh-page-build
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - id: deployment
        uses: actions/deploy-pages@v5

The same workflow, on Latchkey

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

name: Documentation Deployment
on:
  release:
    types: [published]
  workflow_dispatch:
permissions:
  contents: write
jobs:
  gh-page-build:
    timeout-minutes: 30
    runs-on: latchkey-small
    if: github.event_name != 'release' || github.event.release.prerelease == false
    steps:
      - uses: actions/checkout@v7
        with:
          fetch-depth: 0
      - uses: astral-sh/setup-uv@v7
      - run: uv run mkdocs build
        env:
          MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }}
      - uses: actions/upload-pages-artifact@v5
        with:
          path: site
  gh-page-deploy:
    timeout-minutes: 30
    needs: gh-page-build
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: latchkey-small
    steps:
      - id: deployment
        uses: actions/deploy-pages@v5
 

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.
• Add a job timeout so a hung step cannot burn hours of runner time.

1 third-party action is referenced by a movable tag. Pin it to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.

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