Skip to content
Latchkey

Build doc workflow (PythonOT/POT)

The Build doc workflow from PythonOT/POT, explained and optimized by Latchkey.

C

CI health: C - fair

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

Grade your own workflow free or run it on Latchkey →
Source: PythonOT/POT.github/workflows/build_doc.ymlLicense MITView source

What it does

This is the Build doc workflow from the PythonOT/POT 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 doc

on:
  workflow_dispatch:
  pull_request:
  push:
    branches:
      - 'master'

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v7
      with:
        submodules: true
    # Standard drop-in approach that should work for most people.
    - name: Free Disk Space (Ubuntu)
      uses: insightsengineering/disk-space-reclaimer@v1
      with:
        android: true
        dotnet: true
    - name: Set up Python 3.10
      uses: actions/setup-python@v5
      with:
        python-version: "3.10"
        cache: 'pip'

    - name: Get Python running
      run: |
        python -m pip install --user --upgrade --progress-bar off pip
        python -m pip install --user --upgrade --progress-bar off -r docs/requirements.txt
        python -m pip install --user --upgrade --progress-bar off ipython sphinx-gallery memory_profiler
        python -m pip install -v --user -e .
    # Look at what we have and fail early if there is some library conflict
    - name: Check installation
      run: |
        which python
        python -c "import ot"
    # Build docs
    - name: Generate HTML docs
      uses: rickstaa/sphinx-action@master
      with:
        docs-folder: "docs/"
    - uses: actions/upload-artifact@v7
      with:
        name: Documentation
        path: docs/build/html/

The same workflow, on Latchkey

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

name: Build doc
 
on:
  workflow_dispatch:
  pull_request:
  push:
    branches:
      - 'master'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
 
    runs-on: latchkey-small
 
    steps:
    - uses: actions/checkout@v7
      with:
        submodules: true
    # Standard drop-in approach that should work for most people.
    - name: Free Disk Space (Ubuntu)
      uses: insightsengineering/disk-space-reclaimer@v1
      with:
        android: true
        dotnet: true
    - name: Set up Python 3.10
      uses: actions/setup-python@v5
      with:
        python-version: "3.10"
        cache: 'pip'
 
    - name: Get Python running
      run: |
        python -m pip install --user --upgrade --progress-bar off pip
        python -m pip install --user --upgrade --progress-bar off -r docs/requirements.txt
        python -m pip install --user --upgrade --progress-bar off ipython sphinx-gallery memory_profiler
        python -m pip install -v --user -e .
    # Look at what we have and fail early if there is some library conflict
    - name: Check installation
      run: |
        which python
        python -c "import ot"
    # Build docs
    - name: Generate HTML docs
      uses: rickstaa/sphinx-action@master
      with:
        docs-folder: "docs/"
    - uses: actions/upload-artifact@v7
      with:
        name: Documentation
        path: docs/build/html/
 

What changed

2 third-party actions are referenced by a movable tag. Pin them 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:

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