Migrate to docusaurus #2737
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: Check docs | |
on: | |
push: | |
# We intentionally don't run push on feature branches. See PR for rational. | |
branches: [unstable, stable] | |
pull_request: | |
jobs: | |
build: | |
name: Docs spellcheck | |
runs-on: ubuntu-latest | |
steps: | |
# <common-build> - Uses YAML anchors in the future | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-node@v4 | |
with: | |
node-version: 20 | |
cache: yarn | |
- name: Node.js version | |
id: node | |
run: echo "v8CppApiVersion=$(node --print "process.versions.modules")" >> $GITHUB_OUTPUT | |
- name: Restore dependencies | |
uses: actions/cache@master | |
id: cache-deps | |
with: | |
path: | | |
node_modules | |
packages/*/node_modules | |
key: ${{ runner.os }}-${{ steps.node.outputs.v8CppApiVersion }}-${{ hashFiles('**/yarn.lock', '**/package.json') }} | |
- name: Install & build | |
if: steps.cache-deps.outputs.cache-hit != 'true' | |
run: yarn install --frozen-lockfile && yarn build | |
- name: Build | |
run: yarn build | |
if: steps.cache-deps.outputs.cache-hit == 'true' | |
- name: Check wordlist is sorted | |
run: scripts/wordlist_sort_check.sh | |
- name: Build and collect docs | |
run: yarn docs:build | |
# Run prettier check with fix after generating the docs. The CLI reference is formatted with prettier for | |
# deployed version so this will fail if not "fixable" | |
- name: Check docs format | |
run: yarn docs:lint:fix | |
# Run spellcheck AFTER building docs, in case the CLI reference has issues | |
- name: Spellcheck | |
uses: rojopolis/spellcheck-github-actions@0.32.0 |