Publish to PyPi workflow (dropbox/dropbox-sdk-python)
The Publish to PyPi workflow from dropbox/dropbox-sdk-python, 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.
What it does
This is the Publish to PyPi workflow from the dropbox/dropbox-sdk-python 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
name: Publish to PyPi
on:
release:
types: [created]
workflow_dispatch: # Allow manual trigger for testing
jobs:
deploy:
runs-on: ubuntu-latest
permissions: # required for OIDC authentication
id-token: write
contents: read
steps:
- uses: actions/checkout@v5
- name: Configure AWS credentials (OIDC)
uses: aws-actions/configure-aws-credentials@v4
with:
role-to-assume: arn:aws:iam::082972943155:role/oidc-github-dropbox-dropbox-sdk-python-repo
aws-region: us-west-2
- name: Get PyPI token from AWS Secrets Manager
id: get-secret
uses: aws-actions/aws-secretsmanager-get-secrets@v2
with:
# Referenced by friendly name; Secrets Manager appends a random suffix to
# the full ARN, so the name is the stable identifier.
secret-ids: |
PYPI_SECRET,pypi-api-token-dropbox-sdk-python
parse-json-secrets: false
- name: Setup Python environment
uses: actions/setup-python@v6
with:
python-version: "3.x"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install build twine
- name: Build sdist and wheel
run: python -m build
- name: Publish
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ env.PYPI_SECRET }}
run: |
twine check dist/*
twine upload dist/*
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 name: Publish to PyPi on: release: types: [created] workflow_dispatch: # Allow manual trigger for testing jobs: deploy: timeout-minutes: 30 runs-on: latchkey-small permissions: # required for OIDC authentication id-token: write contents: read steps: - uses: actions/checkout@v5 - name: Configure AWS credentials (OIDC) uses: aws-actions/configure-aws-credentials@v4 with: role-to-assume: arn:aws:iam::082972943155:role/oidc-github-dropbox-dropbox-sdk-python-repo aws-region: us-west-2 - name: Get PyPI token from AWS Secrets Manager id: get-secret uses: aws-actions/aws-secretsmanager-get-secrets@v2 with: # Referenced by friendly name; Secrets Manager appends a random suffix to # the full ARN, so the name is the stable identifier. secret-ids: | PYPI_SECRET,pypi-api-token-dropbox-sdk-python parse-json-secrets: false - name: Setup Python environment uses: actions/setup-python@v6 with: cache: 'pip' python-version: "3.x" - name: Install dependencies run: | python -m pip install --upgrade pip python -m pip install build twine - name: Build sdist and wheel run: python -m build - name: Publish env: TWINE_USERNAME: __token__ TWINE_PASSWORD: ${{ env.PYPI_SECRET }} run: | twine check dist/* twine upload dist/*
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 useslatchkey-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.
2 third-party actions are referenced by a movable tag. Pin them 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.