feat: add pypi release workflow (#58)

tvansteenburgh · web-flow · commit 03584d6301c3 · 2023-09-18T16:45:47.000-04:00
* feat: add pypi release workflow

Add a new GH workflow that will build and publish to PyPI when a new tag
is pushed.

* add test.pypi

* add readme for publishing

* remove test.pypi
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -0,0 +1,83 @@
+name: Publish Python distribution to PyPI
+
+on: push
+
+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.9"
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.5.1
+      - name: Build a binary wheel and a source tarball
+        run: poetry 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/') # only publish to PyPI on tag pushes
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/stacklet.client.platform
+    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
+        with:
+          skip-existing: true
+          verbose: true
+          print-hash: true
+
+  github-release:
+    name: >-
+      Sign the Python distribution with Sigstore
+      and upload 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@v1.2.3
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+      - 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/README.md b/README.md
@@ -3,17 +3,9 @@
 ## Installation
 
 ```
-$ just install
+$ pip install stacklet.client.platform
 ```
 
-## Compiling for distribution
-
-```
-$ just compile
-```
-
-This will create a `stacklet-admin` file which can be distributed. Compiling takes a long time (over 8 minutes). This file is git ignored.
-
 ## Configuration
 
 To get started, use the `auto-configure` command to initialize the CLI configuration
@@ -165,3 +157,11 @@ To return the last account:
 ```
 stacklet-admin account list --last 1
 ```
+
+# Development
+
+## Installation
+
+```
+$ just install
+```
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,6 +6,7 @@ build-backend = "poetry.core.masonry.api"
 name = "stacklet.client.platform"
 version = "0.1.3"
 description = "Stacklet Platform Client"
+readme = "README.md"
 authors = [ "Sonny Shi <sonny@stacklet.io>",]
 include = [ "stacklet/client/platform/vendored/auth_landing_pages/ok.html", "stacklet/client/platform/vendored/auth_landing_pages/fail.html",]
 [[tool.poetry.packages]]
