-
Notifications
You must be signed in to change notification settings - Fork 755
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: use typedoc to build sdk reference (#2308)
Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr>
- Loading branch information
Showing
4 changed files
with
106 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
name: Deploy API Documentation | ||
|
||
on: | ||
release: | ||
types: [published] | ||
|
||
jobs: | ||
build-and-deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v2 | ||
|
||
- uses: actions/setup-node@v2 | ||
with: | ||
node-version: '14' | ||
|
||
- name: restore lock files | ||
uses: actions/cache@master # must use unreleased master to cache multiple paths | ||
id: cache | ||
with: | ||
# must be done before bootstrap to not include node_modules files in the cache paths | ||
path: | | ||
package-lock.json | ||
packages/*/package-lock.json | ||
benchmark/*/package-lock.json | ||
backwards-compatability/*/package-lock.json | ||
metapackages/*/package-lock.json | ||
packages/*/package-lock.json | ||
integration-tests/*/package-lock.json | ||
key: ${{ runner.os }}-unit_test-${{ matrix.node_version }}-${{ hashFiles('**/package.json') }} | ||
- name: Install and Build (cache miss) 🔧 | ||
if: steps.cache.outputs.cache-hit != 'true' | ||
run: | | ||
npm install --ignore-scripts | ||
npx lerna bootstrap --no-ci | ||
npm run compile | ||
- name: Install and Build (cache hit) 🔧 | ||
if: steps.cache.outputs.cache-hit == 'true' | ||
run: | | ||
npm ci --ignore-scripts | ||
npx lerna bootstrap | ||
npm run compile | ||
- name: Build Docs | ||
run: npm run docs | ||
|
||
- name: Deploy Documentation 🚀 | ||
uses: JamesIves/github-pages-deploy-action@releases/v3 | ||
with: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
BRANCH: gh-pages # The branch the action should deploy to. | ||
FOLDER: docs # The folder the action should deploy. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters