Skip to content
Latchkey

Upload Python Package workflow (dromara/domain-admin)

The Upload Python Package workflow from dromara/domain-admin, explained and optimized by Latchkey.

F

CI health: F - at risk

Point runs-on at Latchkey and get caching, 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: dromara/domain-admin.github/workflows/python-publish.ymlLicense MITView source

What it does

This is the Upload Python Package workflow from the dromara/domain-admin 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)
# https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml
# https://docs.pypi.org/trusted-publishers/adding-a-publisher/
name: Upload Python Package

#on:
#  release:
#    types: [published]

#on:
#  push:
#    branch: ['master']

on:
  push:
    tags:
      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10

permissions:
  contents: read

jobs:
  deploy:

    runs-on: ubuntu-latest
    environment:
      name: pypi
      url: https://pypi.org/p/domain-admin

    permissions:
      # IMPORTANT: this permission is mandatory for trusted publishing
      id-token: write
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Set up Python
        uses: actions/setup-python@v3
        with:
          python-version: '3.x'

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install setuptools wheel twine

      # 拉取前端最新的dist代码
      - name: Checkout
        uses: actions/checkout@v3
        with:
          repository: 'mouday/domain-admin-web'
          ref: 'dist'
          token: ${{ secrets.GH_PAT }}
          path: 'domain_admin/public'

      - name: Checkout
        uses: actions/checkout@v3
        with:
          repository: 'mouday/domain-admin-mini'
          ref: 'dist'
          token: ${{ secrets.GH_PAT }}
          path: 'domain_admin/public/m'

      # remove .git
      - name: Remove .git Dir
        run: rm -rf '.git' 'domain_admin/public/.git' 'domain_admin/public/m/.git'

      - name: Build
        run: |
            python setup.py sdist bdist_wheel --python-tag py2.py3
            twine check dist/*

#      - name: Build and publish
#        if: startsWith(github.ref, 'refs/tags/')
#
#        env:
#          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
#          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
#        run: |
#            python setup.py sdist bdist_wheel --python-tag py2.py3
#            twine check dist/*
#            twine upload dist/*
      # Publishing with a Trusted Publisher
      # https://docs.pypi.org/trusted-publishers/using-a-publisher/
      # https://github.com/pypa/gh-action-pypi-publish/
      - name: Publish package distributions to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1

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.

# https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml
# https://docs.pypi.org/trusted-publishers/adding-a-publisher/
name: Upload Python Package
 
#on:
#  release:
#    types: [published]
 
#on:
#  push:
#    branch: ['master']
 
on:
  push:
    tags:
      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
 
permissions:
  contents: read
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  deploy:
    timeout-minutes: 30
 
    runs-on: latchkey-small
    environment:
      name: pypi
      url: https://pypi.org/p/domain-admin
 
    permissions:
      # IMPORTANT: this permission is mandatory for trusted publishing
      id-token: write
    steps:
      - name: Checkout
        uses: actions/checkout@v3
 
      - name: Set up Python
        uses: actions/setup-python@v3
        with:
          cache: 'pip'
          python-version: '3.x'
 
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install setuptools wheel twine
 
      # 拉取前端最新的dist代码
      - name: Checkout
        uses: actions/checkout@v3
        with:
          repository: 'mouday/domain-admin-web'
          ref: 'dist'
          token: ${{ secrets.GH_PAT }}
          path: 'domain_admin/public'
 
      - name: Checkout
        uses: actions/checkout@v3
        with:
          repository: 'mouday/domain-admin-mini'
          ref: 'dist'
          token: ${{ secrets.GH_PAT }}
          path: 'domain_admin/public/m'
 
      # remove .git
      - name: Remove .git Dir
        run: rm -rf '.git' 'domain_admin/public/.git' 'domain_admin/public/m/.git'
 
      - name: Build
        run: |
            python setup.py sdist bdist_wheel --python-tag py2.py3
            twine check dist/*
 
#      - name: Build and publish
#        if: startsWith(github.ref, 'refs/tags/')
#
#        env:
#          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
#          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
#        run: |
#            python setup.py sdist bdist_wheel --python-tag py2.py3
#            twine check dist/*
#            twine upload dist/*
      # Publishing with a Trusted Publisher
      # https://docs.pypi.org/trusted-publishers/using-a-publisher/
      # https://github.com/pypa/gh-action-pypi-publish/
      - name: Publish package distributions to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1
 

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