publish.yml

name: Publish to PyPI

# Publishes the PytorchWildlife package to PyPI when a GitHub Release is published.
# Uses PyPI Trusted Publishing (OIDC) -- no API token or stored secret is required.
#
# One-time maintainer setup (PyPI project owner, account-side):
#   PyPI -> project "PytorchWildlife" -> Manage -> Publishing -> Add a trusted publisher (GitHub Actions):
#     Owner:        microsoft
#     Repository:   Pytorch-Wildlife
#     Workflow:     publish.yml
#     Environment:  pypi
# After that, publishing a GitHub Release runs this workflow and uploads the build.

on:
  release:
    types: [published]

permissions:
  contents: read

jobs:
  build-and-publish:
    name: Build and publish PytorchWildlife
    runs-on: ubuntu-latest
    environment:
      name: pypi
      url: https://pypi.org/project/PytorchWildlife/
    permissions:
      id-token: write   # required for Trusted Publishing (OIDC)
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: '3.11'

      - name: Build sdist and wheel
        run: |
          python -m pip install --upgrade build
          python -m build

      - name: Check distribution metadata
        run: |
          python -m pip install --upgrade twine
          python -m twine check dist/*

      - name: Publish to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1