chore: update ci and add readme

gasp-xyz · Nov 20, 2023 · eff9d2f · eff9d2f
1 parent 96db712
commit eff9d2f
Show file tree

Hide file tree

Showing 5 changed files with 506 additions and 14 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -21,5 +21,15 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
+      - name: Generate docs
+        working-directory: packages/sdk
+        run: npx typedoc src/index.ts --skipErrorChecking
+
+      - name: Deploy github page for doc 🚀
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages # The branch the action should deploy to.
+          folder: docs # The folder the action should deploy.
+
 
 
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@
 dist
 tmp
 /out-tsc
+docs
 
 # dependencies
 node_modules
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,7 @@ @@
     dist
     tmp
     /out-tsc
+    docs
     # dependencies
     node_modules
@@ Expand Down @@