Skip to content
Latchkey

publish-to-pypi workflow (operand/agency)

The publish-to-pypi workflow from operand/agency, explained and optimized by Latchkey.

C

CI health: C - fair

Point runs-on at Latchkey and get run de-duplication, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →
Source: operand/agency.github/workflows/publish_to_pypi.ymlLicense MITView source

What it does

This is the publish-to-pypi 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

workflow (.yml)
name: publish-to-pypi

on:
  push:
    branches:
      - main

jobs:
  publish-to-pypi:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout repository
      uses: actions/checkout@v2
      with:
        fetch-depth: 2

    - name: Install dependencies
      run: npm install @iarna/toml

    - name: Check for version changes
      id: check_version
      uses: actions/github-script@v5
      with:
        script: |
          const fs = require('fs');
          const execSync = require('child_process').execSync;
          const toml = require('@iarna/toml');
          const current = fs.readFileSync('pyproject.toml', 'utf8');
          execSync('git checkout HEAD^1 pyproject.toml');
          const previous = fs.readFileSync('pyproject.toml', 'utf8');
          execSync('git checkout HEAD pyproject.toml');
          const currentVersion = toml.parse(current).tool.poetry.version;
          const previousVersion = toml.parse(previous).tool.poetry.version;
          const versionChanged = currentVersion !== previousVersion;
          if (versionChanged) {
            console.log(`version changed from ${previousVersion} to ${currentVersion}`);
            return currentVersion;
          } else {
            console.log(`version did not change from ${previousVersion}`);
          }

    - name: Install Poetry
      if: ${{ steps.check_version.outputs.result }}
      uses: snok/install-poetry@v1
      with:
        version: 1.5.1

    - name: Build and publish
      if: ${{ steps.check_version.outputs.result }}
      run: |
        echo "Building version ${{ steps.check_version.outputs.result }} ..."
        poetry build
        echo "Publishing ..."
        poetry publish --username __token__ --password ${{ secrets.PYPI_TOKEN }}

The same workflow, on Latchkey

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

name: publish-to-pypi
 
on:
  push:
    branches:
      - main
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  publish-to-pypi:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
    - name: Checkout repository
      uses: actions/checkout@v2
      with:
        fetch-depth: 2
 
    - name: Install dependencies
      run: npm install @iarna/toml
 
    - name: Check for version changes
      id: check_version
      uses: actions/github-script@v5
      with:
        script: |
          const fs = require('fs');
          const execSync = require('child_process').execSync;
          const toml = require('@iarna/toml');
          const current = fs.readFileSync('pyproject.toml', 'utf8');
          execSync('git checkout HEAD^1 pyproject.toml');
          const previous = fs.readFileSync('pyproject.toml', 'utf8');
          execSync('git checkout HEAD pyproject.toml');
          const currentVersion = toml.parse(current).tool.poetry.version;
          const previousVersion = toml.parse(previous).tool.poetry.version;
          const versionChanged = currentVersion !== previousVersion;
          if (versionChanged) {
            console.log(`version changed from ${previousVersion} to ${currentVersion}`);
            return currentVersion;
          } else {
            console.log(`version did not change from ${previousVersion}`);
          }
 
    - name: Install Poetry
      if: ${{ steps.check_version.outputs.result }}
      uses: snok/install-poetry@v1
      with:
        version: 1.5.1
 
    - name: Build and publish
      if: ${{ steps.check_version.outputs.result }}
      run: |
        echo "Building version ${{ steps.check_version.outputs.result }} ..."
        poetry build
        echo "Publishing ..."
        poetry publish --username __token__ --password ${{ secrets.PYPI_TOKEN }}
 

What changed

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:

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