publish docs workflow (tomasvotava/fastapi-sso)

The publish docs workflow from tomasvotava/fastapi-sso, explained and optimized by Latchkey.

What it does

This is the publish docs workflow from the tomasvotava/fastapi-sso 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:
      - master
  workflow_dispatch:

concurrency:
  group: pages
  cancel-in-progress: false

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

jobs:
  build:
    runs-on: ubuntu-latest
    env:
      POETRY_VIRTUALENVS_CREATE: "false"
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v4
        with:
          python-version: 3.12
      - name: Install pipx
        run: python -m pip install pipx && python -m pipx ensurepath
      - name: Install poetry
        run: pipx install poetry && poetry --version
      - name: Install dependencies
        run: poetry install
      - name: Build docs
        run: poetry run poe docs
      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v3
      - name: Upload pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./public

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to Github pages
        id: deployment
        uses: actions/deploy-pages@v4

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:
      - master
  workflow_dispatch:
 
concurrency:
  group: pages
  cancel-in-progress: false
 
permissions:
  contents: write
  id-token: write
  pages: write
 
jobs:
  build:
    timeout-minutes: 30
    runs-on: latchkey-small
    env:
      POETRY_VIRTUALENVS_CREATE: "false"
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: 3.12
      - name: Install pipx
        run: python -m pip install pipx && python -m pipx ensurepath
      - name: Install poetry
        run: pipx install poetry && poetry --version
      - name: Install dependencies
        run: poetry install
      - name: Build docs
        run: poetry run poe docs
      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v3
      - name: Upload pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./public
 
  deploy:
    timeout-minutes: 30
    needs: build
    runs-on: latchkey-small
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to Github pages
        id: deployment
        uses: actions/deploy-pages@v4
 

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

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 2 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow