docs-gh-pages workflow (michaelfeil/infinity)

The docs-gh-pages workflow from michaelfeil/infinity, explained and optimized by Latchkey.

CI health: D - needs work

Point runs-on at Latchkey and get caching, 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: michaelfeil/infinity.github/workflows/docs.yamlLicense MITView source

What it does

This is the docs-gh-pages workflow from the michaelfeil/infinity 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: docs-gh-pages 

on:
  release:
    types: [published]
  push:
    branches:
    - main
permissions:
  contents: write
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/setup-python@v5
        with:
          python-version: 3.11
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Configure Git Credentials
        run: |
          git config user.name github-actions[bot]
          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
      - uses: actions/cache@v4
        with:
          key: mkdocs-material-${{ env.cache_id }}
          path: .cache
          restore-keys: |
            mkdocs-material-
      - name: Install infinity_emb with mkdocs
        run: |
          pip install poetry 
          poetry config virtualenvs.create false
          cd libs/infinity_emb && POETRY_VIRTUALENVS_CREATE=false POETRY_VIRTUALENVS_IN_PROJECT=false poetry install --extras "server" --with mkdocs
      - name: get version
        run: |
          python -c 'import infinity_emb; print(infinity_emb.__version__)'
          echo "INFINITY_VERSION=$(python -c 'import infinity_emb; print(infinity_emb.__version__)')" >> $GITHUB_ENV
      - name: Build and Deploy Release
        # only if the release is published
        if: github.event_name == 'release' && github.event.action == 'published'
        run: |
          cd docs
          mike deploy --push --update-aliases $INFINITY_VERSION latest --alias-type=redirect
      - name: Build and Deploy Dev/main
        # only if dev/main branch is pushed
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        run: |
          cd docs
          mike deploy --push --update-aliases main

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: docs-gh-pages 
 
on:
  release:
    types: [published]
  push:
    branches:
    - main
permissions:
  contents: write
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  deploy:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: 3.11
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Configure Git Credentials
        run: |
          git config user.name github-actions[bot]
          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
      - uses: actions/cache@v4
        with:
          key: mkdocs-material-${{ env.cache_id }}
          path: .cache
          restore-keys: |
            mkdocs-material-
      - name: Install infinity_emb with mkdocs
        run: |
          pip install poetry 
          poetry config virtualenvs.create false
          cd libs/infinity_emb && POETRY_VIRTUALENVS_CREATE=false POETRY_VIRTUALENVS_IN_PROJECT=false poetry install --extras "server" --with mkdocs
      - name: get version
        run: |
          python -c 'import infinity_emb; print(infinity_emb.__version__)'
          echo "INFINITY_VERSION=$(python -c 'import infinity_emb; print(infinity_emb.__version__)')" >> $GITHUB_ENV
      - name: Build and Deploy Release
        # only if the release is published
        if: github.event_name == 'release' && github.event.action == 'published'
        run: |
          cd docs
          mike deploy --push --update-aliases $INFINITY_VERSION latest --alias-type=redirect
      - name: Build and Deploy Dev/main
        # only if dev/main branch is pushed
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        run: |
          cd docs
          mike deploy --push --update-aliases main

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.

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