Deploy docs workflow (Spenhouet/confluence-markdown-exporter)
The Deploy docs workflow from Spenhouet/confluence-markdown-exporter, explained and optimized by Latchkey.
CI health: A - excellent
Point runs-on at Latchkey and get job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.
What it does
This is the Deploy docs workflow from the Spenhouet/confluence-markdown-exporter 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: Deploy docs
on:
push:
branches: [main]
paths:
- "docs/**"
- "versioned_docs/**"
- "versioned_sidebars/**"
- "versions.json"
- "src/**"
- "static/**"
- "docusaurus.config.ts"
- "sidebars.ts"
- "tsconfig.json"
- "package.json"
- "package-lock.json"
- ".github/workflows/docs.yml"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
name: Build docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
with:
fetch-depth: 0
- name: Setup Node
uses: actions/setup-node@v6
with:
node-version: 20
cache: npm
- name: Install dependencies
run: npm ci
- name: Build site (with versioned docs from git tags)
run: npm run build:versioned
- name: Upload artifact
uses: actions/upload-pages-artifact@v5
with:
path: build
deploy:
name: Deploy to GitHub Pages
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
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: Deploy docs on: push: branches: [main] paths: - "docs/**" - "versioned_docs/**" - "versioned_sidebars/**" - "versions.json" - "src/**" - "static/**" - "docusaurus.config.ts" - "sidebars.ts" - "tsconfig.json" - "package.json" - "package-lock.json" - ".github/workflows/docs.yml" workflow_dispatch: permissions: contents: read pages: write id-token: write concurrency: group: pages cancel-in-progress: false jobs: build: timeout-minutes: 30 name: Build docs runs-on: latchkey-small steps: - uses: actions/checkout@v7 with: fetch-depth: 0 - name: Setup Node uses: actions/setup-node@v6 with: node-version: 20 cache: npm - name: Install dependencies run: npm ci - name: Build site (with versioned docs from git tags) run: npm run build:versioned - name: Upload artifact uses: actions/upload-pages-artifact@v5 with: path: build deploy: timeout-minutes: 30 name: Deploy to GitHub Pages needs: build runs-on: latchkey-small environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} steps: - name: Deploy to GitHub Pages 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 useslatchkey-small; pick the runner size that fits the job. - 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.