Skip to content

Commit 4758090

Browse files
authored
ci: update build docs script (#150)
Due to an issue with rollup and typedoc, the Akamai EdgeKV package and the Akamai Base package didn't generate docs correctly. To fix this: - I updated the ci action to use the `doc` command found in the workspace instead of always using the build-docs script. - Added the `doc` script to the packages that didn't have the script listed
2 parents cdc0acc + 13a9d84 commit 4758090

File tree

6 files changed

+6
-3
lines changed

6 files changed

+6
-3
lines changed

actions/ci/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ runs:
4040

4141
- name: Build Docs
4242
shell: bash
43-
run: ./scripts/build-doc.sh ${{ inputs.workspace_path }}
43+
run: yarn workspace ${{ inputs.workspace_name }} doc

packages/sdk/akamai-base/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"dist"
2626
],
2727
"scripts": {
28-
"doc": "../../../scripts/build-doc.sh .",
28+
"doc": "npx typedoc --entryPointStrategy resolve src/index.ts",
2929
"build": "rollup -c rollup.config.js",
3030
"clean": "rimraf dist",
3131
"tsw": "yarn tsc --watch",

packages/sdk/akamai-edgekv/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"dist"
2727
],
2828
"scripts": {
29-
"doc": "../../../scripts/build-doc.sh .",
29+
"doc": "npx typedoc --entryPointStrategy resolve src/index.ts",
3030
"build": "rollup -c rollup.config.js",
3131
"clean": "rimraf dist",
3232
"tsw": "yarn tsc --watch",

packages/sdk/server-node/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
"client"
2020
],
2121
"scripts": {
22+
"doc": "../../../scripts/build-doc.sh .",
2223
"clean": "npx tsc --build --clean",
2324
"//": "We run the tests in-band because the FS tests work best sequential.",
2425
"test": "npx jest --ci --runInBand",

packages/shared/common/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
"client"
2020
],
2121
"scripts": {
22+
"doc": "../../../scripts/build-doc.sh .",
2223
"test": "npx jest --ci",
2324
"build": "npx tsc",
2425
"clean": "npx tsc --build --clean",

packages/shared/sdk-server/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
"client"
2020
],
2121
"scripts": {
22+
"doc": "../../../scripts/build-doc.sh .",
2223
"test": "npx jest --ci",
2324
"build": "npx tsc",
2425
"clean": "npx tsc --build --clean",

0 commit comments

Comments
 (0)