Publish workflow (ajndkr/lanarky)

The Publish workflow from ajndkr/lanarky, explained and optimized by Latchkey.

What it does

This is the Publish workflow from the ajndkr/lanarky 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: Publish

on:
  workflow_dispatch: # Allow running on-demand
  push:
    tags:
      - "*"

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  PYTHON_VERSION: 3.9

jobs:
  build-and-publish:
    runs-on: ubuntu-latest
    steps:
      - name: Code checkout
        uses: actions/checkout@v3

      - name: Setup python
        uses: actions/setup-python@v4
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip poetry
          poetry install

      - name: Set Poetry config
        run: poetry config pypi-token.pypi ${{ secrets.PYPI_API_TOKEN }}

      - name: Publish package
        run: poetry publish --build

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
 
on:
  workflow_dispatch: # Allow running on-demand
  push:
    tags:
      - "*"
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
env:
  PYTHON_VERSION: 3.9
 
jobs:
  build-and-publish:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - name: Code checkout
        uses: actions/checkout@v3
 
      - name: Setup python
        uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: ${{ env.PYTHON_VERSION }}
 
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip poetry
          poetry install
 
      - name: Set Poetry config
        run: poetry config pypi-token.pypi ${{ secrets.PYPI_API_TOKEN }}
 
      - name: Publish package
        run: poetry publish --build
 

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