docs workflow (snakemake/snakemake)

The docs workflow from snakemake/snakemake, explained and optimized by Latchkey.

CI health: B - good

Point runs-on at Latchkey and get job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: snakemake/snakemake.github/workflows/docs.ymlLicense MITView source

What it does

This is the docs workflow from the snakemake/snakemake 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

on:
  push:
    branches:
      - main
  pull_request:

concurrency:
  # Cancel concurrent flows on PRs
  group: ci-docs-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

jobs:
  docs:
    if: github.event.pull_request.merged != true || github.ref != 'refs/heads/main'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7.0.0

      - name: Install Pixi
        uses: prefix-dev/setup-pixi@v0.9.6
        with:
          environments: "docs"
          cache: true
          cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
      
      - name: Build Docs
        run: |
          pixi run --environment docs build-docs

      - name: Upload documentation
        uses: actions/upload-artifact@v7
        with:
          name: docs-html
          path: docs/_build/html/

  apidocs:
    if: github.event.pull_request.merged != true || github.ref != 'refs/heads/main'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7.0.0

      - name: Install Pixi
        uses: prefix-dev/setup-pixi@v0.9.6
        with:
          environments: "docs"
          cache: true
          cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}

      - name: Build API Docs
        run: |
          pixi run --environment docs build-apidocs

      - name: Upload documentation
        uses: actions/upload-artifact@v7
        with:
          name: apidocs-html
          path: apidocs/_build/html/

The same workflow, on Latchkey

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

name: docs
 
on:
  push:
    branches:
      - main
  pull_request:
 
concurrency:
  # Cancel concurrent flows on PRs
  group: ci-docs-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true
 
jobs:
  docs:
    timeout-minutes: 30
    if: github.event.pull_request.merged != true || github.ref != 'refs/heads/main'
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v7.0.0
 
      - name: Install Pixi
        uses: prefix-dev/setup-pixi@v0.9.6
        with:
          environments: "docs"
          cache: true
          cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
      
      - name: Build Docs
        run: |
          pixi run --environment docs build-docs
 
      - name: Upload documentation
        uses: actions/upload-artifact@v7
        with:
          name: docs-html
          path: docs/_build/html/
 
  apidocs:
    timeout-minutes: 30
    if: github.event.pull_request.merged != true || github.ref != 'refs/heads/main'
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v7.0.0
 
      - name: Install Pixi
        uses: prefix-dev/setup-pixi@v0.9.6
        with:
          environments: "docs"
          cache: true
          cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
 
      - name: Build API Docs
        run: |
          pixi run --environment docs build-apidocs
 
      - name: Upload documentation
        uses: actions/upload-artifact@v7
        with:
          name: apidocs-html
          path: apidocs/_build/html/

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

actions/checkout actions/upload-artifact