Merge pull request #360 from karthik2804/fix_docs

Generate docs for modules

Author: karthik2804

.github/workflows/release.yaml

@@ -20,12 +20,6 @@ jobs:
           uses: actions/setup-node@v3
           with:
             node-version: ${{ env.NODE_VERSION }}
-        - name: Install Dependencies
-          shell: bash
-          run: npm install
-        - name: Run prettier check
-          shell: bash
-          run: npm run fmt-check
         - name: Install latest Spin CLI
           uses: fermyon/actions/spin/setup@v1
           with:
@@ -76,15 +70,13 @@ jobs:
     steps:
         - name: Checkout Repository including Tags
           uses: actions/checkout@v4
-        - name: Fetch Git tags
-          run: git fetch --tags
+
         - name: Install Node.js
           uses: actions/setup-node@v3
           with:
             node-version: ${{ env.NODE_VERSION }}
         - name: Generate Spin JS SDK Docs 
-          run: | 
-            ./scripts/build-docs.sh
+          run: npm run docs
         - name: Upload Spin JS SDK Docs as Artifact
           id: docs_deployment
           uses: actions/upload-pages-artifact@v3

package-lock.json

@@ -0,0 +1,27 @@
+{
+  "name": "spin-js-sdk",
+  "version": "1.0.0",
+  "description": "This package is currently used only for generating documentation. It is not a library and does not contain any code.",
+  "main": "index.js",
+  "private": true,
+  "scripts": {
+    "docs": "typedoc",
+    "test": "cd test && ./test.sh"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/spinframework/spin-js-sdk.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "Apache-2.0 WITH LLVM-exception",
+  "type": "module",
+  "bugs": {
+    "url": "https://github.com/spinframework/spin-js-sdk/issues"
+  },
+  "homepage": "https://github.com/spinframework/spin-js-sdk#readme",
+  "devDependencies": {
+    "typedoc": "^0.28.2",
+    "typedoc-plugin-missing-exports": "^4.0.0"
+  }
+}