python_release.yml

name: Release to PyPI and documentation

on:
  push:
    tags: ["python-v*"]

defaults:
  run:
    working-directory: ./python

jobs:
  validate-release-tag:
    name: Validate git tag
    runs-on: ubuntu-slim
    steps:
      # v6.0.2
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
      - name: compare git tag with cargo metadata
        run: |
          PUSHED_TAG=${GITHUB_REF##*/}
          CURR_VER=$( grep version Cargo.toml | head -n 1 | awk '{print $3}' | tr -d '"' )
          if [[ "${PUSHED_TAG}" != "python-v${CURR_VER}" ]]; then
            echo "Cargo metadata has version set to ${CURR_VER}, but got pushed tag ${PUSHED_TAG}."
            exit 1
          fi

  release-pypi-mac:
    needs: validate-release-tag
    name: PyPI release on Mac
    strategy:
      fail-fast: false
      matrix:
        target: [x86_64-apple-darwin, aarch64-apple-darwin]
    runs-on: macos-14
    steps:
      # v6.0.2
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
      - name: Publish to pypi (without sdist)
        # <https://github.com/PyO3/maturin-action/releases/tag/v1.50.1>
        uses: messense/maturin-action@04ac600d27cdf7a9a280dadf7147097c42b757ad
        env:
          MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
        with:
          target: ${{ matrix.target }}
          command: publish
          args: --skip-existing --no-sdist -m python/Cargo.toml --profile python-release

  release-pypi-windows:
    needs: validate-release-tag
    name: PyPI release on Windows
    runs-on: windows-latest
    steps:
      # v6.0.2
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
      # <https://github.com/actions/setup-python/releases/tag/v6.2.0>
      - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405
        with:
          python-version: '3.11'

      - name: Publish to pypi (without sdist)
        # <https://github.com/PyO3/maturin-action/releases/tag/v1.50.1>
        uses: messense/maturin-action@04ac600d27cdf7a9a280dadf7147097c42b757ad
        env:
          MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
        with:
          target: x86_64-pc-windows-msvc
          command: publish
          args: --skip-existing --no-sdist -m python/Cargo.toml  --profile python-release

  release-pypi-sdist:
    needs: validate-release-tag
    name: PyPI source distribution (sdist)
    runs-on: ubuntu-24.04
    steps:
      # v6.0.2
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
      # This is the sole sdist publisher. All wheel jobs use --no-sdist.
      # See: https://github.com/delta-io/delta-rs/issues/4645
      - name: Build sdist
        # <https://github.com/PyO3/maturin-action/releases/tag/v1.50.1>
        uses: messense/maturin-action@04ac600d27cdf7a9a280dadf7147097c42b757ad
        with:
          command: sdist
          args: -m python/Cargo.toml
      - name: Upload sdist to PyPI
        # <https://github.com/PyO3/maturin-action/releases/tag/v1.50.1>
        uses: messense/maturin-action@04ac600d27cdf7a9a280dadf7147097c42b757ad
        env:
          MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
        with:
          command: upload
          args: --skip-existing target/wheels/*.tar.gz

  release-pypi-manylinux-x86-64:
    needs: validate-release-tag
    name: PyPI release on Linux (x86_64-manylinux-2_17)
    runs-on: ubuntu-24.04
    steps:
      # v6.0.2
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
      - name: Publish manylinux to pypi x86_64 (without sdist)
        # <https://github.com/PyO3/maturin-action/releases/tag/v1.50.1>
        uses: messense/maturin-action@04ac600d27cdf7a9a280dadf7147097c42b757ad
        env:
          MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
        with:
          target: x86_64-unknown-linux-gnu
          command: publish
          container: off
          args: --skip-existing --no-sdist -m python/Cargo.toml --zig --profile python-release
          manylinux: "2_17"

  release-pypi-manylinux-228-aarch64:
    needs: validate-release-tag
    name: PyPI release on Linux (aarch64-manylinux-2_28)
    runs-on: ubuntu-24.04-arm
    steps:
      # v6.0.2
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
      - name: Publish manylinux to pypi aarch64 (without sdist)
        # <https://github.com/PyO3/maturin-action/releases/tag/v1.50.1>
        uses: messense/maturin-action@04ac600d27cdf7a9a280dadf7147097c42b757ad
        env:
          MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
          # Build with support for 64K pages on arm instances which is a thing
          # it turns out
          #
          # <https://github.com/delta-io/delta-rs/issues/4413>
          JEMALLOC_SYS_WITH_LG_PAGE: 16
        with:
          target: aarch64-unknown-linux-gnu
          command: publish
          container: off
          args: --skip-existing --no-sdist -m python/Cargo.toml --zig --profile python-release-arm
          manylinux: "2_28"

  release-pypi-musl-x86-64:
    needs: validate-release-tag
    name: PyPI release on Linux (x86_64-musl)
    runs-on: ubuntu-24.04
    steps:
      # v6.0.2
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
      - name: Publish musl to pypi x86_64 (without sdist)
        # <https://github.com/PyO3/maturin-action/releases/tag/v1.50.1>
        uses: messense/maturin-action@04ac600d27cdf7a9a280dadf7147097c42b757ad
        env:
          MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
        with:
          target: x86_64-unknown-linux-musl
          command: publish
          args: --skip-existing --no-sdist -m python/Cargo.toml --zig --profile python-release

  release-pypi-musl-aarch64:
    needs: validate-release-tag
    name: PyPI release on Linux (aarch64-musl)
    runs-on: ubuntu-24.04-arm
    steps:
      # v6.0.2
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
      - name: Publish musl to pypi aarch64 (without sdist)
        # <https://github.com/PyO3/maturin-action/releases/tag/v1.50.1>
        uses: messense/maturin-action@04ac600d27cdf7a9a280dadf7147097c42b757ad
        env:
          MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
          # Build with support for 64K pages on arm instances which is a thing
          # it turns out
          #
          # <https://github.com/delta-io/delta-rs/issues/4413>
          JEMALLOC_SYS_WITH_LG_PAGE: 16
        with:
          target: aarch64-unknown-linux-musl
          command: publish
          args: --skip-existing --no-sdist -m python/Cargo.toml --zig --profile python-release-arm

  release-docs:
    needs:
      [
        validate-release-tag,
        release-pypi-sdist,
        release-pypi-manylinux-x86-64,
        release-pypi-manylinux-228-aarch64,
        release-pypi-musl-x86-64,
        release-pypi-musl-aarch64,
        release-pypi-mac,
        release-pypi-windows,
      ]
    permissions:
      contents: write
    runs-on: ubuntu-slim
    steps:
      - name: Trigger the docs release event
        # <https://github.com/peter-evans/repository-dispatch/releases/tag/v4.0.1>
        uses: peter-evans/repository-dispatch@28959ce8df70de7be546dd1250a005dd32156697
        with:
          event-type: release-docs
          client-payload: >
            {
              "tag": "${{ github.ref_name }}"
            }