checks.yaml

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@d481127c3821f9c278a6019c39a108ac7004c133

      - name: Set up node
        uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b
        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@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
      - 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@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
      - 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'