Publish docs workflow (Doist/todoist-api-python)

The Publish docs workflow from Doist/todoist-api-python, explained and optimized by Latchkey.

What it does

This is the Publish docs workflow from the Doist/todoist-api-python 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: Publish docs

on:
  push:
    branches:
      - main

permissions:
  contents: write

jobs:
  build-and-publish-docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version-file: .python-version

      - name: Set up uv
        uses: astral-sh/setup-uv@v5
        with:
          version: 0.6.11

      - name: Install project
        run: uv sync --group docs

      - name: Deploy to GitHub Pages
        run: uv run mkdocs gh-deploy --no-history

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 docs
 
on:
  push:
    branches:
      - main
 
permissions:
  contents: write
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build-and-publish-docs:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
 
      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          cache: 'pip'
          python-version-file: .python-version
 
      - name: Set up uv
        uses: astral-sh/setup-uv@v5
        with:
          version: 0.6.11
 
      - name: Install project
        run: uv sync --group docs
 
      - name: Deploy to GitHub Pages
        run: uv run mkdocs gh-deploy --no-history
 

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.

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