chore(tsdocs): build apidocs for @loopback/docs during pack

loopbackio · May 21, 2019 · 4e4a400 · 4e4a400
1 parent 9aa76a9
commit 4e4a400
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 7 deletions.
diff --git a/bin/build-docs-site.sh b/bin/build-docs-site.sh
@@ -21,8 +21,9 @@ DIR=`dirname $0`
 REPO_ROOT=$DIR/..
 pushd $REPO_ROOT >/dev/null
 
-# Update README duplicates inside docs/site/readmes
-node docs/bin/copy-readmes.js
+# Update apidocs
+lerna bootstrap --scope @loopback/tsdocs
+lerna run --scope @loopback/docs prepack
 
 # Clean up sandbox/loopback.io directory
 rm -rf sandbox/loopback.io/
@@ -31,7 +32,7 @@ rm -rf sandbox/loopback.io/
 git clone --depth 1 https://github.com/strongloop/loopback.io.git sandbox/loopback.io
 
 # Bootstrap the `loopback.io` package
-lerna bootstrap --scope loopback.io-workflow-scripts
+lerna bootstrap --scope @loopback/docs --scope loopback.io-workflow-scripts
 
 pushd $REPO_ROOT/sandbox/loopback.io/ >/dev/null
 

diff --git a/docs/package.json b/docs/package.json
@@ -16,7 +16,7 @@
   ],
   "scripts": {
     "build:apidocs": "lb-apidocs --html-file=index.html",
-    "prepack": "node ./bin/copy-readmes",
+    "prepack": "node ./bin/copy-readmes && cd .. && npm run tsdocs",
     "clean": "lb-clean loopback-docs*.tgz package api-docs apidocs site/readmes site/apidocs"
   },
   "devDependencies": {

diff --git a/package.json b/package.json
@@ -35,7 +35,7 @@
     "version": "npm run update-packages && git add greenkeeper.json \"**/package-lock.json\" && npm run update-template-deps && npm run apidocs",
     "outdated": "npm outdated --depth 0 && lerna exec --no-bail \"npm outdated --depth 0\"",
     "apidocs": "node bin/run-lerna run build:apidocs",
-    "tsdocs": "lerna run --scope @loopback/tsdocs tsdocs",
+    "tsdocs": "lerna run --scope @loopback/tsdocs build:tsdocs",
     "coverage:ci": "node packages/build/bin/run-nyc report --reporter=text-lcov | coveralls",
     "precoverage": "npm test",
     "coverage": "open coverage/index.html",

diff --git a/packages/tsdocs/README.md b/packages/tsdocs/README.md
@@ -13,7 +13,7 @@ It's built on top of https://api-extractor.com/:
 ### Build api reports and doc models
 
 ```sh
-npm run extract-apidocs
+npm run extract-apidocs -- --report
 ```
 
 The command above will traverse all TypeScript packages in the monorepo and run
@@ -42,6 +42,12 @@ npm run update-apidocs
 It adds Jekyll metadata to markdown files in `loopback-next/docs/site/apidocs`
 and generates `loopback-next/docs/site/apidocs/index.md` as the index page.
 
+To run all steps together:
+
+```sh
+npm run build:apidocs
+```
+
 ## Installation
 
 ```sh

diff --git a/packages/tsdocs/package.json b/packages/tsdocs/package.json
@@ -7,7 +7,7 @@
   },
   "private": true,
   "scripts": {
-    "tsdocs": "npm run build && npm run -s extract-apidocs && npm run -s document-apidocs && npm run -s update-apidocs",
+    "build:tsdocs": "npm run build && npm run -s extract-apidocs && npm run -s document-apidocs && npm run -s update-apidocs",
     "extract-apidocs": "node bin/extract-apis",
     "document-apidocs": "api-documenter markdown -i ../../docs/apidocs/models -o ../../docs/site/apidocs",
     "update-apidocs": "node bin/update-apidocs",