Skip to content

Commit 5db2463

Browse files
authored
chore(ci): run TypeDoc generation in Code Quality Checks action (#4345)
* chore(ci): run TypeDoc generation in Code Quality Checks action * chore: remove outdated/unused copy of `generate-typedoc.js` Outdated file: `typedoc` is only a dependency of `website/`, and this file lacked the latest updates requried for recent typedoc compatibility.
1 parent 7b203e0 commit 5db2463

File tree

2 files changed

+43
-38
lines changed

2 files changed

+43
-38
lines changed

.github/workflows/linting.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,3 +93,46 @@ jobs:
9393
command: yarn --no-audit --prefer-offline
9494
- name: Lint
9595
run: yarn run tsc:compile
96+
97+
98+
typedoc:
99+
name: TypeDoc Generation
100+
runs-on: ubuntu-latest
101+
timeout-minutes: 15
102+
steps:
103+
- uses: styfle/[email protected]
104+
with:
105+
access_token: ${{ github.token }}
106+
- uses: actions/checkout@v2
107+
with:
108+
fetch-depth: 1
109+
- uses: actions/setup-node@v2-beta
110+
with:
111+
node-version: 12
112+
- name: Get yarn cache directory path
113+
id: yarn-cache-dir-path
114+
run: echo "::set-output name=dir::$(yarn cache dir)"
115+
- uses: actions/cache@v2
116+
name: Yarn Cache
117+
id: yarn-cache
118+
with:
119+
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
120+
key: ${{ runner.os }}-yarn-${{ hashFiles('**/package.json') }}-with-website
121+
restore-keys: |
122+
${{ runner.os }}-yarn-
123+
- name: Yarn Install
124+
uses: nick-invision/retry@v1
125+
with:
126+
timeout_minutes: 3
127+
retry_wait_seconds: 30
128+
max_attempts: 3
129+
command: yarn --no-audit --prefer-offline
130+
- name: Yarn Install (Website)
131+
uses: nick-invision/retry@v1
132+
with:
133+
timeout_minutes: 3
134+
retry_wait_seconds: 30
135+
max_attempts: 3
136+
command: cd website && yarn --no-audit --prefer-offline
137+
- name: Generate TypeDoc
138+
run: node -e "require('./website/scripts/generate-typedoc').generateTypedoc()"

scripts/generate-typedoc.js

Lines changed: 0 additions & 38 deletions
This file was deleted.

0 commit comments

Comments
 (0)