Upload Python Package workflow (salt-die/terminal_dungeon)

The Upload Python Package workflow from salt-die/terminal_dungeon, explained and optimized by Latchkey.

What it does

This is the Upload Python Package workflow from the salt-die/terminal_dungeon 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

# This workflow will upload a Python Package using Twine when a release is created

# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries


# This workflow uses actions that are not certified by GitHub.

# They are provided by a third-party and are governed by

# separate terms of service, privacy policy, and support

# documentation.


name: Upload Python Package


on:
  release:
    types: [published]


jobs:
  deploy:

    runs-on: ubuntu-latest


    steps:
    - uses: actions/checkout@v3

    - name: Set up Python

      uses: actions/setup-python@v4

      with:
        python-version: '3.x'

    - name: Install dependencies

      run: |

        python -m pip install --upgrade pip

        pip install build

    - name: Build package

      run: python -m build

    - name: Publish package

      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29

      with:
        user: __token__

        password: ${{ secrets.PYPI_API_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.

# This workflow will upload a Python Package using Twine when a release is created

# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries



# This workflow uses actions that are not certified by GitHub.

# They are provided by a third-party and are governed by

# separate terms of service, privacy policy, and support

# documentation.



name: Upload Python Package



on:

  release:

    types: [published]



jobs:

  deploy:

    timeout-minutes: 30



    runs-on: latchkey-small



    steps:

    - uses: actions/checkout@v3

    - name: Set up Python

      uses: actions/setup-python@v4

      with:

        cache: 'pip'

        python-version: '3.x'

    - name: Install dependencies

      run: |

        python -m pip install --upgrade pip

        pip install build

    - name: Build package

      run: python -m build

    - name: Publish package

      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29

      with:

        user: __token__

        password: ${{ secrets.PYPI_API_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.

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