deploy-github-page workflow (operand/agency)

The deploy-github-page workflow from operand/agency, explained and optimized by Latchkey.

What it does

This is the deploy-github-page workflow from the operand/agency 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

name: deploy-github-page

on:
  push:
    branches:
      - main

permissions:
  contents: write

jobs:
  deploy-github-page:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v2

    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '3.9'

    - name: Install dependencies
      run: |
        python3 -m pip install --upgrade pip poetry
        poetry install
        poetry add pdoc docstring-parser

    - name: Generate API documentation
      run: |
        poetry run pdoc agency \
          --template-directory site/pdoc_templates \
          --docformat google \
          --output-dir site/_api_docs


    - name: Set up Ruby and Jekyll
      uses: ruby/setup-ruby@v1
      with:
        ruby-version: '3.2.2'

    - name: Build the site
      env:
        JEKYLL_ENV: production
      run: |
        cd site
        gem install bundler
        bundle install
        bundle exec jekyll build

    - name: Deploy to GitHub Pages
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./site/_site
        cname: createwith.agency

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: deploy-github-page
 
on:
  push:
    branches:
      - main
 
permissions:
  contents: write
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  deploy-github-page:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    steps:
    - name: Checkout code
      uses: actions/checkout@v2
 
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        cache: 'pip'
        python-version: '3.9'
 
    - name: Install dependencies
      run: |
        python3 -m pip install --upgrade pip poetry
        poetry install
        poetry add pdoc docstring-parser
 
    - name: Generate API documentation
      run: |
        poetry run pdoc agency \
          --template-directory site/pdoc_templates \
          --docformat google \
          --output-dir site/_api_docs
 
 
    - name: Set up Ruby and Jekyll
      uses: ruby/setup-ruby@v1
      with:
        ruby-version: '3.2.2'
 
    - name: Build the site
      env:
        JEKYLL_ENV: production
      run: |
        cd site
        gem install bundler
        bundle install
        bundle exec jekyll build
 
    - name: Deploy to GitHub Pages
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./site/_site
        cname: createwith.agency
 

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

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