Build Adapter Docs workflow (adapter-hub/adapters)

The Build Adapter Docs workflow from adapter-hub/adapters, explained and optimized by Latchkey.

What it does

This is the Build Adapter Docs workflow from the adapter-hub/adapters 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: Build Adapter Docs

on:
  push:
    branches: [ main ]
    paths:
      - '.github/workflows/**'
      - 'docs/**'
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          ref: main
          fetch-depth: 0
      - uses: actions/setup-python@v2
        with:
          python-version: "3.10"
      - name: Install
        run: |
          pip install setuptools==57.4.0
          pip install torch
          pip install recommonmark==0.7.1
          pip install -e .[docs]
          pip install Jinja2==2.11.3
          pip install markupsafe==2.0.1
      - name: Build
        run: |
          cd docs && make html-multi-version && cd ..
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          user_name: "Adapter-Hub-Bert"
          user_email: "---"
          publish_dir: ./docs/_build/html
          publish_branch: gh-pages
          force_orphan: true
          cname: docs.adapterhub.ml

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: Build Adapter Docs
 
on:
  push:
    branches: [ main ]
    paths:
      - '.github/workflows/**'
      - 'docs/**'
  workflow_dispatch:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v3
        with:
          ref: main
          fetch-depth: 0
      - uses: actions/setup-python@v2
        with:
          cache: 'pip'
          python-version: "3.10"
      - name: Install
        run: |
          pip install setuptools==57.4.0
          pip install torch
          pip install recommonmark==0.7.1
          pip install -e .[docs]
          pip install Jinja2==2.11.3
          pip install markupsafe==2.0.1
      - name: Build
        run: |
          cd docs && make html-multi-version && cd ..
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          user_name: "Adapter-Hub-Bert"
          user_email: "---"
          publish_dir: ./docs/_build/html
          publish_branch: gh-pages
          force_orphan: true
          cname: docs.adapterhub.ml
 

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.
• 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.

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.

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