ci: deploy documentation on releases (open-telemetry#629)

* ci: deploy documentation on releases * ci: only deploy docs on x.x.0 updates * fix: remove personal email from ci * chore: add docs-deploy script Co-authored-by: Mayur Kale <mayurkale@google.com>
cthulhu-bot · Dec 20, 2019 · 3593a69 · 3593a69
1 parent 587a5f5
commit 3593a69
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 2 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -166,6 +166,29 @@ jobs:
       - run:
           name: Docs tests
           command: yarn docs-test
+      - persist_to_workspace:
+          root: packages/opentelemetry-types/docs
+          paths:
+            - out
+  docs-deploy:
+    docker:
+      - image: node:12
+    steps:
+      - checkout
+      - attach_workspace:
+          at: packages/opentelemetry-types/docs
+      - run:
+          name: Install and configure dependencies
+          command: |
+            npm install --silent --no-save gh-pages
+            git config user.email noreply@opentelemetry.io
+            git config user.name "ci-build"
+      - add_ssh_keys:
+          fingerprints:
+            - "1d:a3:60:b5:b4:8d:e7:8a:96:ce:6a:0a:e9:58:4c:54"
+      - run:
+          name: Deploy docs to gh-pages branch
+          command: gh-pages --dist packages/opentelemetry-types/docs/out
   node8:
     docker:
       - image: node:8
@@ -202,7 +225,18 @@ workflows:
   version: 2
   build:
     jobs:
-      - lint_&_docs
+      - lint_&_docs:
+          filters:
+            branches:
+              only: /.*/
+      - docs-deploy:
+          requires:
+            - lint_&_docs
+          filters:
+            tags:
+              only: /^v\d+\.\d+\.0$/
+            branches:
+              ignore: /.*/
       - node8
       - node10
       - node12

diff --git a/package.json b/package.json
@@ -21,7 +21,8 @@
     "check": "lerna run check",
     "predocs-test": "yarn docs",
     "docs-test": "lerna run docs-test",
-    "docs": "lerna run docs"
+    "docs": "lerna run docs",
+    "docs-deploy": "gh-pages --dist packages/opentelemetry-types/docs/out"
   },
   "repository": "open-telemetry/opentelemetry-js",
   "keywords": [
@@ -38,6 +39,7 @@
     "@commitlint/config-conventional": "^8.2.0",
     "beautify-benchmark": "^0.2.4",
     "benchmark": "^2.1.4",
+    "gh-pages": "^2.1.1",
     "gts": "^1.1.0",
     "husky": "^3.0.9",
     "lerna": "^3.17.0",