Skip to content

Commit 3593a69

Browse files
dyladanmayurkale22
andcommitted
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 <[email protected]>
1 parent 587a5f5 commit 3593a69

File tree

2 files changed

+38
-2
lines changed

2 files changed

+38
-2
lines changed

Diff for: .circleci/config.yml

+35-1
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,29 @@ jobs:
166166
- run:
167167
name: Docs tests
168168
command: yarn docs-test
169+
- persist_to_workspace:
170+
root: packages/opentelemetry-types/docs
171+
paths:
172+
- out
173+
docs-deploy:
174+
docker:
175+
- image: node:12
176+
steps:
177+
- checkout
178+
- attach_workspace:
179+
at: packages/opentelemetry-types/docs
180+
- run:
181+
name: Install and configure dependencies
182+
command: |
183+
npm install --silent --no-save gh-pages
184+
git config user.email [email protected]
185+
git config user.name "ci-build"
186+
- add_ssh_keys:
187+
fingerprints:
188+
- "1d:a3:60:b5:b4:8d:e7:8a:96:ce:6a:0a:e9:58:4c:54"
189+
- run:
190+
name: Deploy docs to gh-pages branch
191+
command: gh-pages --dist packages/opentelemetry-types/docs/out
169192
node8:
170193
docker:
171194
- image: node:8
@@ -202,7 +225,18 @@ workflows:
202225
version: 2
203226
build:
204227
jobs:
205-
- lint_&_docs
228+
- lint_&_docs:
229+
filters:
230+
branches:
231+
only: /.*/
232+
- docs-deploy:
233+
requires:
234+
- lint_&_docs
235+
filters:
236+
tags:
237+
only: /^v\d+\.\d+\.0$/
238+
branches:
239+
ignore: /.*/
206240
- node8
207241
- node10
208242
- node12

Diff for: package.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@
2121
"check": "lerna run check",
2222
"predocs-test": "yarn docs",
2323
"docs-test": "lerna run docs-test",
24-
"docs": "lerna run docs"
24+
"docs": "lerna run docs",
25+
"docs-deploy": "gh-pages --dist packages/opentelemetry-types/docs/out"
2526
},
2627
"repository": "open-telemetry/opentelemetry-js",
2728
"keywords": [
@@ -38,6 +39,7 @@
3839
"@commitlint/config-conventional": "^8.2.0",
3940
"beautify-benchmark": "^0.2.4",
4041
"benchmark": "^2.1.4",
42+
"gh-pages": "^2.1.1",
4143
"gts": "^1.1.0",
4244
"husky": "^3.0.9",
4345
"lerna": "^3.17.0",

0 commit comments

Comments
 (0)