extract jsdoc imports #4260
Workflow file for this run
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
name: Documentation | |
on: | |
workflow_dispatch: | |
push: | |
branches: | |
- '**' | |
pull_request: | |
branches: | |
- '**' | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.ref }} | |
cancel-in-progress: true | |
jobs: | |
spelling: | |
name: 'Spelling & Grammar' | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 1 | |
- uses: actions/setup-node@v3 | |
with: | |
node-version: 18 | |
- name: Set workflow variables | |
id: workflow-variables | |
run: echo "yarn-cache-dir=$(yarn cache dir)" >> $GITHUB_OUTPUT | |
- uses: actions/cache/restore@v3 | |
name: Yarn Cache Restore | |
id: yarn-cache | |
with: | |
path: ${{ steps.workflow-variables.outputs.yarn-cache-dir }} | |
key: ${{ runner.os }}-yarn-v1-${{ hashFiles('yarn.lock') }} | |
restore-keys: ${{ runner.os }}-yarn-v1 | |
- name: Yarn Install | |
uses: nick-fields/retry@v2 | |
with: | |
timeout_minutes: 15 | |
retry_wait_seconds: 30 | |
max_attempts: 3 | |
command: yarn --no-audit --prefer-offline | |
- name: Lint | |
run: yarn lint:markdown | |
- name: Install Dependencies | |
uses: nick-fields/retry@v2 | |
with: | |
timeout_minutes: 10 | |
retry_wait_seconds: 60 | |
max_attempts: 3 | |
command: sudo npm install --global spellchecker-cli | |
- name: Spell check | |
run: | | |
yarn lint:spellcheck | |
- uses: actions/cache/save@v3 | |
name: Yarn Cache Save | |
if: "${{ github.ref == 'refs/heads/main' }}" | |
with: | |
path: ${{ steps.workflow-variables.outputs.yarn-cache-dir }} | |
key: ${{ runner.os }}-yarn-v1-${{ hashFiles('yarn.lock') }} |