Deploy documentation workflow (s3prl/s3prl)

The Deploy documentation workflow from s3prl/s3prl, explained and optimized by Latchkey.

What it does

This is the Deploy documentation workflow from the s3prl/s3prl 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: Deploy documentation

on:
  push:
    branches:
      - main
      - debug

jobs:
  deploy-doc:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Create virtual environment
        run: |
          python3 -m venv "$HOME/s3prl_env"
          echo "$HOME/s3prl_env/bin" >> $GITHUB_PATH

      - name: Install Linux dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y libsndfile1-dev sox

      - name: Upgrade pip and wheel
        run: pip3 install --upgrade pip wheel setuptools

      # - name: Setup upterm sessions
      #   uses: lhotari/action-upterm@v1

      - name: install S3PRL
        run: |
          pip install -e ".[dev]"

      - name: Build doc
        run: |
          cd docs/
          ./rebuild_docs.sh

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        if: ${{ github.ref == 'refs/heads/main' }}
        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: Deploy documentation
 
on:
  push:
    branches:
      - main
      - debug
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  deploy-doc:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v3
 
      - name: Create virtual environment
        run: |
          python3 -m venv "$HOME/s3prl_env"
          echo "$HOME/s3prl_env/bin" >> $GITHUB_PATH
 
      - name: Install Linux dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y libsndfile1-dev sox
 
      - name: Upgrade pip and wheel
        run: pip3 install --upgrade pip wheel setuptools
 
      # - name: Setup upterm sessions
      #   uses: lhotari/action-upterm@v1
 
      - name: install S3PRL
        run: |
          pip install -e ".[dev]"
 
      - name: Build doc
        run: |
          cd docs/
          ./rebuild_docs.sh
 
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        if: ${{ github.ref == 'refs/heads/main' }}
        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.
• 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