Sphinx Pages workflow (oh-my-ocr/text_renderer)

The Sphinx Pages workflow from oh-my-ocr/text_renderer, explained and optimized by Latchkey.

What it does

This is the Sphinx Pages workflow from the oh-my-ocr/text_renderer 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: Sphinx Pages

on:
  push:
    branches: [ master ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v5

    - name: Install uv
      uses: astral-sh/setup-uv@v7
      with:
        python-version: "3.10"

    - name: Install dependencies
      run: uv sync --locked --no-dev --extra docs

    - name: Build docs
      run: |
        cd docs
        uv run make html

    - name: Push to gh-pages branch
      run: |
        cd docs/_build/html
        git init
        git config user.name "ohmyocr"
        git config user.email "ohmyocr@gmail.com"
        git add .
        git commit -m "pages"
        git branch -m gh-pages
        git remote add origin https://$GITHUB_ACTOR:${{ secrets.GITHUB_TOKEN }}@github.com/oh-my-ocr/text_renderer.git
        git push origin gh-pages -f

The same workflow, on Latchkey

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

name: Sphinx Pages
 
on:
  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@v5
 
    - name: Install uv
      uses: astral-sh/setup-uv@v7
      with:
        python-version: "3.10"
 
    - name: Install dependencies
      run: uv sync --locked --no-dev --extra docs
 
    - name: Build docs
      run: |
        cd docs
        uv run make html
 
    - name: Push to gh-pages branch
      run: |
        cd docs/_build/html
        git init
        git config user.name "ohmyocr"
        git config user.email "ohmyocr@gmail.com"
        git add .
        git commit -m "pages"
        git branch -m gh-pages
        git remote add origin https://$GITHUB_ACTOR:${{ secrets.GITHUB_TOKEN }}@github.com/oh-my-ocr/text_renderer.git
        git push origin gh-pages -f
 

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.

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.

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