Skip to content

fix: typos, formatting, etc #1912

fix: typos, formatting, etc

fix: typos, formatting, etc #1912

Workflow file for this run

name: 'Run Checks: Lint, Audit and Build'
on:
pull_request:
branches:
- main
jobs:
build:
name: Run Checks
runs-on: ubuntu-latest
steps:
# Check out the repository
- name: Cached LFS checkout
uses: nschloe/action-cached-lfs-checkout@f46300cd8952454b9f0a21a3d133d4bd5684cfc2
- name: Set up node
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af
with:
node-version: '18'
registry-url: 'https://registry.npmjs.org'
cache: 'npm'
- name: Install dependencies
run: npm install
# Run Prettier
- name: Run Prettier
run: npm run format:check
# Run ESLint
- name: Run eslint
run: npm run lint
- name: Audit dependencies
run: npm audit
# Audit will fail until update-notifier is updated by Docusaurus
continue-on-error: true
- name: Check types
run: npm run typecheck
- name: Check for circular dependencies
run: npx madge --circular . --extensions ts,js,jsx,tsx
- name: Build with npm
run: npm run build
# Checking to ensure markdown link is not broken
markdown-link-check-md:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: gaurav-nelson/github-action-markdown-link-check@5c5dfc0ac2e225883c0e5f03a85311ec2830d368
with:
file-extension: '.md'
use-quiet-mode: 'yes'
config-file: '.github/workflows/markdown.links.config.json'
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: gaurav-nelson/github-action-markdown-link-check@5c5dfc0ac2e225883c0e5f03a85311ec2830d368
with:
file-extension: '.mdx'
use-quiet-mode: 'yes'
config-file: '.github/workflows/markdown.links.config.json'