check-internal-links.yml

name: "Internal link checking"

on: [pull_request]

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  check-internal-links:
    runs-on: ubuntu-latest
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - name: Check out repo
        uses: actions/checkout@v2
      # Node is required for npm
      - name: Set up Node
        uses: actions/setup-node@v2
        with:
          node-version: "18"
      - name: Pull & update submodules recursively
        run: |
          git submodule update --init --recursive
      # Fail the build in PRs, but not for Netlify previews or production builds
      - name: Fail build on error
        run: |
          sed -Ei 's/onBroken([A-Za-z]+): "warn"/onBroken\1: "throw"/g' docusaurus.config.js
      - name: Faster builds
        run: |
          sed -Ei 's/experimental_faster: "false"/experimental_faster: "true"/g' docusaurus.config.js
      # Install and build Docusaurus website
      - name: Build Docusaurus website
        run: |
          npm install
          npm run build