Upload Python Package workflow (vanvalenlab/deepcell-tf)

The Upload Python Package workflow from vanvalenlab/deepcell-tf, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get caching, 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: vanvalenlab/deepcell-tf.github/workflows/pypi.yamlLicense Apache-2.0View source

What it does

This is the Upload Python Package workflow from the vanvalenlab/deepcell-tf repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

workflow (.yml)

# This workflows 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

name: Upload Python Package

on:
  release:
    types: [published]

jobs:
  deploy:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: "3.10"

    - name: Build a source distribution
      run: python setup.py sdist

    - name: Publish distribution 📦 to PyPI
      if: startsWith(github.ref, 'refs/tags')
      uses: pypa/gh-action-pypi-publish@release/v1
      with:
        user: __token__
        password: ${{ secrets.PYPI_PASSWORD }}
  
  deploy-cpu:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: "3.10"

    - name: Build a source distribution
      run: |
        sed -i "s/tensorflow~=/tensorflow-cpu~=/g" setup.py
        sed -i "s/tensorflow==/tensorflow-cpu==/g" setup.py
        sed -i "s/tensorflow>=/tensorflow-cpu>=/g" setup.py
        sed -i "s/tensorflow<=/tensorflow-cpu<=/g" setup.py
        sed -i "s/tensorflow!=/tensorflow-cpu!=/g" setup.py
        sed -i -e "/__title__ =/ s/= .*/= 'DeepCell-CPU'/" deepcell/_version.py
        python setup.py sdist

    - name: Publish distribution 📦 to PyPI
      if: startsWith(github.ref, 'refs/tags')
      uses: pypa/gh-action-pypi-publish@release/v1
      with:
        user: __token__
        password: ${{ secrets.PYPI_PASSWORD }}

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 workflows 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
 
name: Upload Python Package
 
on:
  release:
    types: [published]
 
jobs:
  deploy:
    timeout-minutes: 30
 
    runs-on: latchkey-small
 
    steps:
    - uses: actions/checkout@v4
 
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        cache: 'pip'
        python-version: "3.10"
 
    - name: Build a source distribution
      run: python setup.py sdist
 
    - name: Publish distribution 📦 to PyPI
      if: startsWith(github.ref, 'refs/tags')
      uses: pypa/gh-action-pypi-publish@release/v1
      with:
        user: __token__
        password: ${{ secrets.PYPI_PASSWORD }}
  
  deploy-cpu:
    timeout-minutes: 30
 
    runs-on: latchkey-small
 
    steps:
    - uses: actions/checkout@v4
 
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        cache: 'pip'
        python-version: "3.10"
 
    - name: Build a source distribution
      run: |
        sed -i "s/tensorflow~=/tensorflow-cpu~=/g" setup.py
        sed -i "s/tensorflow==/tensorflow-cpu==/g" setup.py
        sed -i "s/tensorflow>=/tensorflow-cpu>=/g" setup.py
        sed -i "s/tensorflow<=/tensorflow-cpu<=/g" setup.py
        sed -i "s/tensorflow!=/tensorflow-cpu!=/g" setup.py
        sed -i -e "/__title__ =/ s/= .*/= 'DeepCell-CPU'/" deepcell/_version.py
        python setup.py sdist
 
    - name: Publish distribution 📦 to PyPI
      if: startsWith(github.ref, 'refs/tags')
      uses: pypa/gh-action-pypi-publish@release/v1
      with:
        user: __token__
        password: ${{ secrets.PYPI_PASSWORD }}

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.

This workflow runs 2 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow

actions/checkout actions/setup-python