release.yml

name: release

# Releasing on push tags is less customizable compared to release upon request.
on:
#  push:
#    tags:
#      - 'v[0-9]+.[0-9]+.[0-9]+'
  release:
    types: [published]
    inputs:
      release-pypi:
        required: true
        type: boolean
        default: true
  workflow_dispatch:
    inputs:
      release-pypi:
        required: true
        type: boolean
        description: "if true a release is made on PyPI"

jobs:
  test:
    uses: ./.github/workflows/test.yml

  build:
    needs: test
    uses: ./.github/workflows/build.yml

  docs:
    needs: test
    uses: ./.github/workflows/docs.yml
    secrets: inherit

  release-pypi:
    needs: [build]
    runs-on: ubuntu-latest
    if: github.event.inputs.release-pypi == 'true'

    steps:
      - uses: actions/download-artifact@v3
        with:
          name: artifact
          path: dist

      - uses: pypa/gh-action-pypi-publish@release/v1
        with:
          verbose: true
          user: __token__
          password: ${{ secrets.PYPI_API_TOKEN }}