python-release.yml

# See PyRTL's release documentation in release/README.md
#
# This file configures GitHub actions for building distribution archives and
# uploading them to PyPI.
#
# This configuration is based on the "Publishing package distribution releases
# using GitHub Actions" tutorial at
# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/

name: Build and publish release

on: push

jobs:
  # Verify that distribution archives can be built on every push.
  build:
    name: Build and upload distribution archives
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: "3.x"
    - name: Install pypa/build
      run: python3 -m pip install build
    - name: Build distribution archives
      run: python3 -m build
    - name: Upload distribution archives
      uses: actions/upload-artifact@v4
      with:
        name: python-distribution-archives
        path: dist/
        compression-level: 0

  # Publish distribution archive to TestPyPI on tag pushes.
  publish-to-testpypi:
    name: Publish distribution archives on TestPyPI
    # Only publish to TestPyPI on tag pushes.
    if: startsWith(github.ref, 'refs/tags/')
    needs:
    - build
    runs-on: ubuntu-latest
    environment:
      name: testpypi
      url: https://test.pypi.org/p/pyrtl
    permissions:
      # Required for trusted publishing.
      id-token: write

    steps:
    - name: Download distribution archives
      uses: actions/download-artifact@v3
      with:
        name: python-distribution-archives
        path: dist/
    - name: Publish distribution archives
      uses: pypa/gh-action-pypi-publish@release/v1
      with:
        repository-url: https://test.pypi.org/legacy/

  # Publish distribution archive to PyPI on tag pushes. The 'pypi' environment
  # requires manual approval on GitHub, so this job won't start automatically.
  publish-to-pypi:
    name: Publish distribution archives on PyPI
    # Only publish to PyPI on tag pushes.
    if: startsWith(github.ref, 'refs/tags/')
    needs:
    - build
    runs-on: ubuntu-latest
    environment:
      name: pypi
      url: https://pypi.org/p/pyrtl
    permissions:
      # Required for trusted publishing.
      id-token: write

    steps:
    - name: Download distribution archives
      uses: actions/download-artifact@v3
      with:
        name: python-distribution-archives
        path: dist/
    - name: Publish distribution archives
      uses: pypa/gh-action-pypi-publish@release/v1