🛠️ GitHub Action: Publish Python Package

📄 Description

The Publish Python Package GitHub Action builds and publishes a Python package. It builds the package, creating both a binary wheel and a source tarball, and publishes them to the specified PyPi instance.

It needs a GitHub environment and a variable PYPI_REPO_URL defined.

⚙️ Inputs

Name	Description	Required	Default
out_dir	Directory where builds are saved to.	No	dist/

📦 Usage Example

The repository needs a pyproject.toml.

Set up two environments in GitHub and add a publisher on PyPi.

The environment name needs to be set up in PyPi as publisher. We are normally using two environments for TestPyPi (nightly builds) and PyPi (releases). The environments are named testpypi and pypi. The environment pypi needs a protection rule so that each deployment is reviewed manually. It should also just be used by protected branches only. The environment variable PYPI_REPO_URL needs to be defined (https://test.pypi.org/legacy/ or https://upload.pypi.org/legacy/).

See this link for more information.

Use this action by creating a workflow file, for example .github/workflows/release-testpypi.yml:

---
name: Publish to TestPyPI

on:
  push:
    branches:
      - main

permissions: read-all

jobs:
  test:
    uses: "./.github/workflows/test.yml"
  regression-test:
    uses: "./.github/workflows/regression-test.yml"
    secrets: inherit
  publish-to-testpypi:
    runs-on: ubuntu-latest
    needs:
      - test
      - regression-test
    environment:
      name: testpypi
      url: https://test.pypi.org/p/<my_package>
    permissions:
      id-token: write # IMPORTANT: mandatory for trusted publishing
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - name: Update Python Package Version
        uses: platomo/update-version-py-action@v1
        with:
          version: nightly
          file-path: "<my_package>"
      - name: Publish Python Package
        uses: platomo/publish-pypi-action@v1

or .github/workflows/release-pypi.yml:

---
name: Publish to PyPI

on:
  push:
    tags:
      - "v*.*.*"

permissions: read-all

jobs:
  test:
    if: endsWith(github.event.base_ref, 'main')
    uses: "./.github/workflows/test.yml"
  regression-test:
    if: endsWith(github.event.base_ref, 'main')
    uses: "./.github/workflows/regression-test.yml"
    secrets: inherit
  publish-to-pypi:
    runs-on: ubuntu-latest
    needs:
      - test
      - regression-test
    environment:
      name: pypi
      url: https://pypi.org/p/<my_package>
    permissions:
      id-token: write # IMPORTANT: mandatory for trusted publishing
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - name: Update Python Package Version
        uses: platomo/update-version-py-action@v1
        with:
          version: ${{ github.ref_name }}
          file-path: "<my_package>"
      - name: Publish Python Package
        uses: platomo/publish-pypi-action@v1

🆕 Create a new release

To create a new release of the action, use the GitHub release function and create a new tag according to semantic version requirements (vX.Y.Z). The GitHub workflow major-release-tag.yml will automatically move the major version tag to the new release.

⚖️ License

GNU GENERAL PUBLIC LICENSE Version 3