Build Documentation workflow (hakancelikdev/unimport)

The Build Documentation workflow from hakancelikdev/unimport, explained and optimized by Latchkey.

CI health: C - fair

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

Grade your own workflow free or run it on Latchkey →

Source: hakancelikdev/unimport.github/workflows/docs.ymlLicense MITView source

What it does

This is the Build Documentation workflow from the hakancelikdev/unimport 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

workflow (.yml)

name: Build Documentation

on:
  push:
    tags:
      - "**"

env:
  PYTHON_VERSION: "3.13"

jobs:
  build:
    name: Build and deploy documentation
    runs-on: ubuntu-latest

    permissions:
      contents: write
      pages: write
      id-token: write

    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Set up Python ${{ env.PYTHON_VERSION }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ env.PYTHON_VERSION }}
          architecture: x64
          cache: "pip"

      - name: Cache pip dependencies
        uses: actions/cache@v4
        with:
          path: ~/.cache/pip
          key:
            ${{ runner.os }}-pip-${{ env.PYTHON_VERSION }}-${{
            hashFiles('**/pyproject.toml') }}
          restore-keys: |
            ${{ runner.os }}-pip-${{ env.PYTHON_VERSION }}-

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install .[docs]

      - name: Configure Git
        run: |
          git config --local user.email "hakancelikdev@gmail.com"
          git config --local user.name "Hakan Celik"

      - name: Fetch all branches
        run: git fetch --all

      - name: Deploy documentation
        run: |
          mike deploy ${{ github.ref_name }} latest --update-aliases --push
        timeout-minutes: 10

The same workflow, on Latchkey

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

name: Build Documentation
 
on:
  push:
    tags:
      - "**"
 
env:
  PYTHON_VERSION: "3.13"
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    name: Build and deploy documentation
    runs-on: latchkey-small
 
    permissions:
      contents: write
      pages: write
      id-token: write
 
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
 
      - name: Set up Python ${{ env.PYTHON_VERSION }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ env.PYTHON_VERSION }}
          architecture: x64
          cache: "pip"
 
      - name: Cache pip dependencies
        uses: actions/cache@v4
        with:
          path: ~/.cache/pip
          key:
            ${{ runner.os }}-pip-${{ env.PYTHON_VERSION }}-${{
            hashFiles('**/pyproject.toml') }}
          restore-keys: |
            ${{ runner.os }}-pip-${{ env.PYTHON_VERSION }}-
 
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install .[docs]
 
      - name: Configure Git
        run: |
          git config --local user.email "hakancelikdev@gmail.com"
          git config --local user.name "Hakan Celik"
 
      - name: Fetch all branches
        run: git fetch --all
 
      - name: Deploy documentation
        run: |
          mike deploy ${{ github.ref_name }} latest --update-aliases --push
        timeout-minutes: 10

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.

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/checkout actions/setup-python actions/cache