Publish stand-alone documentation workflow (Superalgos/Superalgos)
The Publish stand-alone documentation workflow from Superalgos/Superalgos, 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.
What it does
This is the Publish stand-alone documentation workflow from the Superalgos/Superalgos 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
name: Publish stand-alone documentation
on:
push:
branches:
- feature/exporting-docs
jobs:
build:
if: github.repository != 'superalgos/superalgos'
name: Build documentation
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [16.x]
steps:
- uses: actions/checkout@v3
- run: rm -f package-lock.json
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
- run: npm install --omit=optional
- name: Preparation
id: prep
run: node export-docs -l=_site -r=Superalgos
- name: Build artifact
uses: actions/upload-pages-artifact@v1
deploy:
if: github.repository != 'superalgos/superalgos'
name: Deploy documentation
needs: build
runs-on: ubuntu-latest
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
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: Publish stand-alone documentation on: push: branches: - feature/exporting-docs concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: build: timeout-minutes: 30 if: github.repository != 'superalgos/superalgos' name: Build documentation runs-on: latchkey-small strategy: matrix: node-version: [16.x] steps: - uses: actions/checkout@v3 - run: rm -f package-lock.json - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v3 with: cache: 'npm' node-version: ${{ matrix.node-version }} - run: npm install --omit=optional - name: Preparation id: prep run: node export-docs -l=_site -r=Superalgos - name: Build artifact uses: actions/upload-pages-artifact@v1 deploy: timeout-minutes: 30 if: github.repository != 'superalgos/superalgos' name: Deploy documentation needs: build runs-on: latchkey-small permissions: pages: write # to deploy to Pages id-token: write # to verify the deployment originates from an appropriate source environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} steps: - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v1
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. - 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 2 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.