Publish ncem to PyPI workflow (theislab/ncem)

The Publish ncem to PyPI workflow from theislab/ncem, explained and optimized by Latchkey.

What it does

This is the Publish ncem to PyPI workflow from the theislab/ncem 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: Publish ncem to PyPI

on:
    release:
        types: [published]

jobs:
    release:
        name: Release
        runs-on: ubuntu-latest
        steps:
            - name: Check out the repository
              uses: actions/checkout@v2.3.4
              with:
                  fetch-depth: 2

            - name: Set up Python
              uses: actions/setup-python@v4.3.0
              with:
                  python-version: "3.8"

            - name: Install Poetry
              run: |
                  pip install poetry
                  poetry --version

            - name: Build package
              run: |
                  poetry build --ansi

            - name: Publish package on PyPI
              uses: pypa/gh-action-pypi-publish@v1.4.2
              with:
                  # COOKIETEMPLE: Configure your PyPI Token to enable automatic deployment to PyPi on releases
                  # https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets
                  user: __token__
                  password: ${{ secrets.PYPI_TOKEN }}

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 ncem to PyPI
 
on:
    release:
        types: [published]
 
jobs:
    release:
        timeout-minutes: 30
        name: Release
        runs-on: latchkey-small
        steps:
            - name: Check out the repository
              uses: actions/checkout@v2.3.4
              with:
                  fetch-depth: 2
 
            - name: Set up Python
              uses: actions/setup-python@v4.3.0
              with:
                  cache: 'pip'
                  python-version: "3.8"
 
            - name: Install Poetry
              run: |
                  pip install poetry
                  poetry --version
 
            - name: Build package
              run: |
                  poetry build --ansi
 
            - name: Publish package on PyPI
              uses: pypa/gh-action-pypi-publish@v1.4.2
              with:
                  # COOKIETEMPLE: Configure your PyPI Token to enable automatic deployment to PyPi on releases
                  # https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets
                  user: __token__
                  password: ${{ secrets.PYPI_TOKEN }}
 

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.

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