ci: add docs tests (open-telemetry#188)

srikanthccv · Aug 13, 2019 · 5c0add0 · 5c0add0
1 parent 4bf949d
commit 5c0add0
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -54,6 +54,17 @@ jobs:
       - run:
           name: Check code style and linting
           command: yarn run check
+  docs:
+    docker:
+      - image: node
+    steps:
+      - checkout
+      - run:
+          name: Install modules and dependencies.
+          command: yarn install
+      - run:
+          name: Docs tests
+          command: yarn docs-test
   node8:
     docker:
       - image: node:8
@@ -80,6 +91,7 @@ workflows:
   build:
     jobs:
       - lint
+      - docs
       - node8
       - node10
       - node11

diff --git a/package.json b/package.json
@@ -14,6 +14,8 @@
     "bump": "lerna publish",
     "codecov": "lerna run codecov",
     "check": "lerna run check",
+    "predocs-test": "yarn docs",
+    "docs-test": "lerna run docs-test",
     "docs": "lerna run docs"
   },
   "repository": "open-telemetry/opentelemetry-js",

diff --git a/packages/opentelemetry-types/package.json b/packages/opentelemetry-types/package.json
@@ -11,6 +11,7 @@
     "compile": "tsc -p .",
     "fix": "gts fix",
     "test": "npm run compile && npm run check",
+    "docs-test": "linkinator docs/out",
     "docs": "typedoc --tsconfig tsconfig.json"
   },
   "keywords": [
@@ -39,6 +40,7 @@
   },
   "devDependencies": {
     "gts": "^1.0.0",
+    "linkinator": "^1.5.0",
     "typedoc": "^0.14.2",
     "typescript": "^3.4.5"
   }