automatic publishing to Pypi and TestPypi using Github Actions (#62)

* adding gh actions workflow for automatic publishing with pypi and testpypi * bumping version number to 0.1.1 * set branch for github workflow to feature branch for testing * changing version number * reverting changes to branch name and version number after successful publishing test on TestPypi * Update .github/workflows/publish-to-pypi-and-testpypi.yml Co-authored-by: Michael Denker <[email protected]> * Update .github/workflows/publish-to-pypi-and-testpypi.yml Co-authored-by: Michael Denker <[email protected]> * Update .github/workflows/publish-to-pypi-and-testpypi.yml Co-authored-by: Michael Denker <[email protected]> * Update .github/workflows/publish-to-pypi-and-testpypi.yml Co-authored-by: Michael Denker <[email protected]> * change tag-triggered publishing to trigger only for tags that start with "v" * Fixed typo into AUTHORS file (#60) --------- Co-authored-by: Michael Denker <[email protected]> Co-authored-by: Cosimo Lupo <[email protected]>
NeuralEnsemble · Jul 18, 2024 · 419c44c · 419c44c
1 parent 391ad59
commit 419c44c
Show file tree

Hide file tree

Showing 3 changed files with 124 additions and 2 deletions.
diff --git a/.github/workflows/publish-to-pypi-and-testpypi.yml b/.github/workflows/publish-to-pypi-and-testpypi.yml
@@ -0,0 +1,122 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - 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 Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/v')  # only publish to PyPI on tag pushes
+    needs:
+      - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/cobrawap
+
+    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 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:
+     - 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/[email protected]
+        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 }}'
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    needs:
+      - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/cobrawap
+
+    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 distribution 📦 to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
diff --git a/VERSION b/VERSION
@@ -1,2 +1,2 @@
-0.1.0
+0.1.1
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [project]
 name = "cobrawap"
 description = "Collaborative Brain Wave Analysis Pipeline (Cobrawap)"
-version = "0.1.0"
+version = "0.1.1"
 readme = "README.rst"
 authors = [
     { name = "Cobrawap authors and contributors", email = "[email protected]" }