Plugin: publisher-pypi

Builds Python source and wheel distributions with python -m build and uploads dist/* artifacts to PyPI (or TestPyPI / private indexes) using twine upload.

Installation

Binary

semrel plugin install @semrel/publisher-pypi

semrel plugin install downloads the binary to .semrel/plugins/ and updates .semrel.lock. Commit .semrel.lock to pin the version for your team.

Docker

Pre-built, signed multi-platform images (linux/amd64, linux/arm64) are published on every release:

docker pull ghcr.io/semrels/publisher-pypi:latest

Verify the image signature with cosign:

cosign verify ghcr.io/semrels/publisher-pypi:latest \
  --certificate-identity-regexp 'https://github.com/SemRels/publisher-pypi/.github/workflows/release.yml.*' \
  --certificate-oidc-issuer https://token.actions.githubusercontent.com

Configuration

version: 1
plugins:
  - uses: @semrel/updater-python
    phase: pre-tag
    args:
      file: pyproject.toml

  - uses: @semrel/publisher-pypi
    phase: release
    args:
      pypi_token: '${env.PYPI_API_TOKEN}'
      # Optional: target TestPyPI or a private index
      # pypi_repository_url: "https://test.pypi.org/legacy/"

Environment Variables

Name	Required	Default	Description
`SEMREL_PLUGIN_PYPI_TOKEN`	yes (unless dry-run)	`—`	PyPI API token passed as `TWINE_PASSWORD` (`__token__` username).
`SEMREL_PLUGIN_PYPI_REPOSITORY_URL`	no	PyPI default	Custom repository URL passed to `twine upload --repository-url` (e.g. `https://test.pypi.org/legacy/`).
`SEMREL_PLUGIN_WORKDIR`	no	`.`	Project directory where `python -m build` and `dist/` are evaluated.
`SEMREL_PLUGIN_PYTHON_BIN`	no	`python` / `python3`	Override the Python executable name or path.
`SEMREL_PLUGIN_TWINE_BIN`	no	`twine`	Override the `twine` executable name or path.

Release Context Variables

SEMREL_VERSION
SEMREL_NEXT_VERSION
SEMREL_DRY_RUN

Behavior

Detects python or python3 on $PATH.
Runs python -m build in the configured working directory.
Collects artifacts in dist/*.
Uploads distributions via twine upload (or logs the planned artifacts without uploading when SEMREL_DRY_RUN=true).

Source

SemRels/publisher-pypi