documentation workflow (instadeepai/mlip)

The documentation workflow from instadeepai/mlip, explained and optimized by Latchkey.

What it does

This is the documentation workflow from the instadeepai/mlip repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

name: documentation


on:
  push:
    branches: [main]


permissions:
  contents: write


jobs:
  docs:
    runs-on: ubuntu-latest

    container:
       image: python:3.12-slim

    steps:
      - uses: actions/checkout@v5


      - name: Setup

        run: |

          apt-get update && apt-get install -y coreutils git


      - name: Install uv

        uses: astral-sh/setup-uv@v7


      - name: Sphinx build

        run: |

          uv run sphinx-build -b html docs/source _build


      - name: Deploy to GitHub Pages

        uses: peaceiris/actions-gh-pages@v3

        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

        with:
          publish_branch: gh-pages

          github_token: ${{ secrets.GITHUB_TOKEN }}

          publish_dir: _build/

          force_orphan: true

The same workflow, on Latchkey

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

name: documentation



on:

  push:

    branches: [main]



permissions:

  contents: write



concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true



jobs:

  docs:

    timeout-minutes: 30

    runs-on: latchkey-small

    container:

       image: python:3.12-slim

    steps:

      - uses: actions/checkout@v5



      - name: Setup

        run: |

          apt-get update && apt-get install -y coreutils git



      - name: Install uv

        uses: astral-sh/setup-uv@v7



      - name: Sphinx build

        run: |

          uv run sphinx-build -b html docs/source _build



      - name: Deploy to GitHub Pages

        uses: peaceiris/actions-gh-pages@v3

        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

        with:

          publish_branch: gh-pages

          github_token: ${{ secrets.GITHUB_TOKEN }}

          publish_dir: _build/

          force_orphan: true

 

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.

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:

• 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