From 636533952fd4b42cfc834e346ec3402f0c5db343 Mon Sep 17 00:00:00 2001 From: Florent Benoit Date: Thu, 21 Mar 2019 11:33:02 +0100 Subject: [PATCH] Publish typedoc to github pages on deploy Change-Id: I3cef27ba76804cd3194ed81c2d343be9ad9e0282 Signed-off-by: Florent Benoit --- .gitignore | 1 + .travis.yml | 17 ++++++++++++----- package.json | 2 ++ yarn.lock | 5 +++++ 4 files changed, 20 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index f1e4a846854b4..a5c9cab098ebe 100644 --- a/.gitignore +++ b/.gitignore @@ -20,3 +20,4 @@ package-backup.json .Trash-* packages/plugin/typedoc plugins +gh-pages diff --git a/.travis.yml b/.travis.yml index c6c6385b7140f..3f61d8ecedc3c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -118,9 +118,16 @@ jobs: before_deploy: - printf "//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}\n" >> ~/.npmrc - yarn + - yarn run docs-modules deploy: - provider: script - script: yarn run publish:next - on: - branch: master - skip_cleanup: true + - provider: script + script: yarn run publish:next + on: + branch: master + skip_cleanup: true + - provider: pages + skip-cleanup: true + github-token: $GITHUB_TOKEN + local-dir: gh-pages + on: + branch: master diff --git a/package.json b/package.json index 2b4dcfa67989f..23c4e65e7a6eb 100644 --- a/package.json +++ b/package.json @@ -36,6 +36,7 @@ "tslint": "^5.12.0", "tslint-language-service": "^0.9.9", "typedoc": "^0.13.0", + "typedoc-plugin-external-module-map": "^1.0.0", "typescript": "^3.1.3", "uuid": "^3.1.0", "wdio-mocha-framework": "0.5.13", @@ -50,6 +51,7 @@ "build": "run build", "build:clean": "run prepare", "docs": "run docs \"@theia/!(example-)*\"", + "docs-modules": "rimraf gh-pages/docs/next && typedoc --readme README.MD --name 'Theia TypeDoc' --exclude '**/+(dev-packages|examples|typings)/**/*.ts' --options configs/typedoc.json --module commonjs --target es6 --hideGenerator --mode modules --external-modulemap '.*\/packages\/([\\w\\-_]+)\/' --out gh-pages/docs/next", "test": "yarn test:theia && yarn test:electron && yarn test:browser", "test:theia": "run test \"@theia/!(example-)*\" --stream --concurrency=1", "test:browser": "yarn rebuild:browser && run test \"@theia/example-browser\"", diff --git a/yarn.lock b/yarn.lock index 451f9755815b5..016fd4ba81e3d 100644 --- a/yarn.lock +++ b/yarn.lock @@ -9460,6 +9460,11 @@ typedoc-default-themes@^0.5.0: version "0.5.0" resolved "https://registry.yarnpkg.com/typedoc-default-themes/-/typedoc-default-themes-0.5.0.tgz#6dc2433e78ed8bea8e887a3acde2f31785bd6227" +typedoc-plugin-external-module-map@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/typedoc-plugin-external-module-map/-/typedoc-plugin-external-module-map-1.0.0.tgz#7021d0e2bc9a98b7266f4ea2eab593b7c63802ce" + integrity sha512-OtlTOmanX0yqRYUVLBuGSBjrffLLAjWNn8mqh6k6FkvfXAIIe3Yfg0kCeKZDN/65v4dt3MJ9AuGXTGLPue3Kqg== + typedoc@^0.13.0: version "0.13.0" resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.13.0.tgz#9efdf352bd54873955cd161bd4b75f24a8c59dde"