release.yml

name: Release

on:
  push:
    tags:
      - "v*"

permissions:
  contents: write

jobs:
  test:
    name: Test before release
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
          cache: pip
          cache-dependency-path: setup.cfg

      - name: Install and test
        run: |
          pip install -e .
          pip install pytest
          pytest --tb=short -q

  # TODO: Add PyPI publish step once trusted publisher is configured on pypi.org
  # See: https://docs.pypi.org/trusted-publishers/adding-a-publisher/

  github-release:
    name: Create GitHub Release
    needs: test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Create GitHub Release
        env:
          GH_TOKEN: ${{ github.token }}
        run: gh release create "${{ github.ref_name }}" --generate-notes