add a GitHub Action to release to PyPI when a new tag is created

Author: dchukhin

.github/workflows/build.yml

@@ -0,0 +1,102 @@
+name: Publish to PyPI
+on:
+  push:
+    branches: [main]
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.13"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    
+    # If the event that triggered this workflow is a push of a tag, then build with
+    # the version of that tag.
+    - name: Build a binary wheel and a source tarball for tag
+      run: BUILD_VERSION=${{ github.ref_name }} python3 -m build
+      if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    # The event that trigged this workflow is not a tag, so build without specifying the version.
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+      if: "!startsWith(github.ref, 'refs/tags/')"
+    
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  pypi-publish:
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    needs: [build]
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/wagtail-thumbnail-choice-block
+    permissions:
+      id-token: write
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - pypi-publish
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/gh-action-sigstore-python@v3
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --generate-notes
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'

README.md

@@ -287,3 +287,9 @@ Developed by Lincoln Loop.
 ## Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Releases
+
+Releases are done with GitHub Actions whenever a new tag is created. For more information,
+see `<./.github/workflows/build.yml>`_. If adding a new tag, make sure to first update the
+version in pyproject.toml.