Master Docs Publication workflow (scikit-learn-contrib/category_encoders)

The Master Docs Publication workflow from scikit-learn-contrib/category_encoders, explained and optimized by Latchkey.

What it does

This is the Master Docs Publication workflow from the scikit-learn-contrib/category_encoders repository, a real project running GitHub Actions. It is shown here with attribution under its BSD-3-Clause license.

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

The workflow

name: "Master Docs Publication"
on:
  release:
    types: created

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - name: Clone
        uses: actions/checkout@v2
      - name: Dependencies
        run: |
          python -m pip install --upgrade pip wheel
          python -m pip install poetry
          poetry install
      - name: Directly build docs
        run: |
          pip install -r docs/requirements.txt
          sphinx-build docs/source ./docs/build/html/
      - name: Deploy Docs
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/build/html

The same workflow, on Latchkey

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

name: "Master Docs Publication"
on:
  release:
    types: created
 
jobs:
  docs:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - name: Clone
        uses: actions/checkout@v2
      - name: Dependencies
        run: |
          python -m pip install --upgrade pip wheel
          python -m pip install poetry
          poetry install
      - name: Directly build docs
        run: |
          pip install -r docs/requirements.txt
          sphinx-build docs/source ./docs/build/html/
      - name: Deploy Docs
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/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.

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