Skip to content

Commit 6bb64e0

Browse files
committed
Generate docs for modules
This PR does a couple of things - Removes the old docs generation script and only generate the current version - Introduces a package.json at the root level as the first step towards to converting this to a npm workspace. This is currently used to generate docs. Signed-off-by: Karthik Ganeshram <[email protected]>
1 parent 06dcba7 commit 6bb64e0

File tree

5 files changed

+365
-89
lines changed

5 files changed

+365
-89
lines changed

.github/workflows/release.yaml

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,6 @@ jobs:
2020
uses: actions/setup-node@v3
2121
with:
2222
node-version: ${{ env.NODE_VERSION }}
23-
- name: Install Dependencies
24-
shell: bash
25-
run: npm install
26-
- name: Run prettier check
27-
shell: bash
28-
run: npm run fmt-check
2923
- name: Install latest Spin CLI
3024
uses: fermyon/actions/spin/setup@v1
3125
with:
@@ -76,15 +70,13 @@ jobs:
7670
steps:
7771
- name: Checkout Repository including Tags
7872
uses: actions/checkout@v4
79-
- name: Fetch Git tags
80-
run: git fetch --tags
73+
8174
- name: Install Node.js
8275
uses: actions/setup-node@v3
8376
with:
8477
node-version: ${{ env.NODE_VERSION }}
8578
- name: Generate Spin JS SDK Docs
86-
run: |
87-
./scripts/build-docs.sh
79+
run: npm run docs
8880
- name: Upload Spin JS SDK Docs as Artifact
8981
id: docs_deployment
9082
uses: actions/upload-pages-artifact@v3

package-lock.json

Lines changed: 319 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"name": "spin-js-sdk",
3+
"version": "1.0.0",
4+
"description": "This is an SDK for Javascript and Typescript based on [ComponentizeJS](https://github.com/bytecodealliance/ComponentizeJS).",
5+
"main": "index.js",
6+
"private": true,
7+
"scripts": {
8+
"docs": "typedoc",
9+
"test": "cd test && ./test.sh"
10+
},
11+
"repository": {
12+
"type": "git",
13+
"url": "git+https://github.com/spinframework/spin-js-sdk.git"
14+
},
15+
"keywords": [],
16+
"author": "",
17+
"license": "Apache-2.0 WITH LLVM-exception",
18+
"type": "module",
19+
"bugs": {
20+
"url": "https://github.com/spinframework/spin-js-sdk/issues"
21+
},
22+
"homepage": "https://github.com/spinframework/spin-js-sdk#readme",
23+
"devDependencies": {
24+
"typedoc": "^0.28.2",
25+
"typedoc-plugin-missing-exports": "^4.0.0"
26+
}
27+
}

0 commit comments

Comments
 (0)