Publish Docs workflow (jorisroovers/gitlint)

The Publish Docs workflow from jorisroovers/gitlint, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get caching, 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: jorisroovers/gitlint.github/workflows/publish-docs.ymlLicense MITView source

What it does

This is the Publish Docs workflow from the jorisroovers/gitlint 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: Publish Docs
run-name: "Publish Docs (docs_version=${{ inputs.docs_version }})"

on:
  workflow_call:
    inputs:
      docs_version:
        description: "Version to build docs for (dev | latest | 0.19.x | ...)"
        required: true
        type: string
  workflow_dispatch:
    inputs:
      docs_version:
        description: "Version to build docs for (dev | latest | 0.19.x | ...)"
        type: string
        default: dev
  
permissions:
  contents: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:

      # Checkout the gh-pages branch, we need to commit the docs to this branch below
      - uses: actions/checkout@v3.3.0
        with:
          ref: gh-pages
      
      #  Now checkout the git ref on which we're working
      - uses: actions/checkout@v3.3.0

      - uses: actions/setup-python@v4.7.0
        with:
          python-version: 3.11

      - name: Install Hatch
        run: python -m pip install hatch==1.7.0

      - name: Configure Git for GitHub Actions bot
        run: |
          git config --local user.name 'github-actions[bot]'
          git config --local user.email 'github-actions[bot]@users.noreply.github.com'

      - name: Deploy dev docs
        run: hatch run docs:mike deploy --push --update-aliases ${{ inputs.docs_version }}

      # Note that it will take a few mins after this workflow has finished for the docs to be available on
      # http://jorisroovers.github.io/gitlint

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
run-name: "Publish Docs (docs_version=${{ inputs.docs_version }})"
 
on:
  workflow_call:
    inputs:
      docs_version:
        description: "Version to build docs for (dev | latest | 0.19.x | ...)"
        required: true
        type: string
  workflow_dispatch:
    inputs:
      docs_version:
        description: "Version to build docs for (dev | latest | 0.19.x | ...)"
        type: string
        default: dev
  
permissions:
  contents: write
 
jobs:
  deploy:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
 
      # Checkout the gh-pages branch, we need to commit the docs to this branch below
      - uses: actions/checkout@v3.3.0
        with:
          ref: gh-pages
      
      #  Now checkout the git ref on which we're working
      - uses: actions/checkout@v3.3.0
 
      - uses: actions/setup-python@v4.7.0
        with:
          cache: 'pip'
          python-version: 3.11
 
      - name: Install Hatch
        run: python -m pip install hatch==1.7.0
 
      - name: Configure Git for GitHub Actions bot
        run: |
          git config --local user.name 'github-actions[bot]'
          git config --local user.email 'github-actions[bot]@users.noreply.github.com'
 
      - name: Deploy dev docs
        run: hatch run docs:mike deploy --push --update-aliases ${{ inputs.docs_version }}
 
      # Note that it will take a few mins after this workflow has finished for the docs to be available on
      # http://jorisroovers.github.io/gitlint

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