Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(ci): run TypeDoc generation in Code Quality Checks action #4345

Merged
merged 2 commits into from
Oct 1, 2020
Merged

chore(ci): run TypeDoc generation in Code Quality Checks action #4345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1266bcc
chore(ci): run TypeDoc generation in Code Quality Checks action
davidgovea Oct 1, 2020
66a54e6
chore: remove outdated/unused copy of `generate-typedoc.js`
davidgovea Oct 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions .github/workflows/linting.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,46 @@ jobs:
command: yarn --no-audit --prefer-offline
- name: Lint
run: yarn run tsc:compile


typedoc:
name: TypeDoc Generation
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- uses: styfle/cancel-workflow-action@0.4.1
with:
access_token: ${{ github.token }}
- uses: actions/checkout@v2
with:
fetch-depth: 1
- uses: actions/setup-node@v2-beta
with:
node-version: 12
- name: Get yarn cache directory path
id: yarn-cache-dir-path
run: echo "::set-output name=dir::$(yarn cache dir)"
- uses: actions/cache@v2
name: Yarn Cache
id: yarn-cache
with:
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
key: ${{ runner.os }}-yarn-${{ hashFiles('**/package.json') }}-with-website
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

interesting I think if you just put the yarn-cache from checkout package.json doesn't have the full thing yet so that key won't be right. This seems like a fine workaround given that it's not in the workspace so not in package.json by default.

restore-keys: |
${{ runner.os }}-yarn-
- name: Yarn Install
uses: nick-invision/retry@v1
with:
timeout_minutes: 3
retry_wait_seconds: 30
max_attempts: 3
command: yarn --no-audit --prefer-offline
- name: Yarn Install (Website)
uses: nick-invision/retry@v1
with:
timeout_minutes: 3
retry_wait_seconds: 30
max_attempts: 3
command: cd website && yarn --no-audit --prefer-offline
- name: Generate TypeDoc
run: node -e "require('./website/scripts/generate-typedoc').generateTypedoc()"
38 changes: 0 additions & 38 deletions scripts/generate-typedoc.js
View file
Open in desktop

This file was deleted.