From 5f5cf9e0fe3e74ee2ffa1a166bf9d8ed66f07574 Mon Sep 17 00:00:00 2001
From: Jan Boelts <jan.boelts@mailbox.org>
Date: Wed, 4 Sep 2024 15:41:51 +0200
Subject: [PATCH] build: add workflow to publish to PyPI

---
 .github/workflows/build_docs.yml |  2 +-
 .github/workflows/publish.yml    | 96 ++++++++++++++++++++++++++++++++
 pyproject.toml                   | 14 ++---
 3 files changed, 104 insertions(+), 8 deletions(-)
 create mode 100644 .github/workflows/publish.yml

diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index 4dbce0aa8..7e1e58991 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -1,4 +1,4 @@
-name: "Build docs and deploy"
+name: "Build and deploy docs"
 on:
   push:
     branches:
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
new file mode 100644
index 000000000..89d36eb6a
--- /dev/null
+++ b/.github/workflows/publish.yml
@@ -0,0 +1,96 @@
+name: Build and publish 📦
+
+on:
+  release:
+    types: [ published ]
+  workflow_dispatch:
+
+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.9"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish to PyPI 🐍
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sbi
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign with Sigstore 🔐
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    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@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/gh-action-sigstore-python@v2.1.1
+      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 }}'
+        --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 }}'
diff --git a/pyproject.toml b/pyproject.toml
index d20e3935a..71c270459 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -49,18 +49,18 @@ dependencies = [
 [project.optional-dependencies]
 doc = [
     # Documentation
-    "jupyter_contrib_nbextensions",
-    "notebook <= 6.4.12",
-    "nbconvert",
-    "nbformat",
-    "traitlets <= 5.9.0",
     "ipython <= 8.9.0",
+    "jupyter_contrib_nbextensions",
+    "mike",
     "mkdocs",
-    "mkdocs-material",
     "markdown-include",
+    "mkdocs-material",
     "mkdocs-redirects",
     "mkdocstrings[python] >= 0.18",
-    "mike"
+    "nbconvert",
+    "nbformat",
+    "notebook <= 6.4.12",
+    "traitlets <= 5.9.0",
 ]
 dev = [
     "ffmpeg",