link_checker.yml

name: Link checker

on:
  pull_request:
  workflow_dispatch:
  schedule:
    - cron: '0 12 * * *'

defaults:
  run:
    shell: bash

jobs:
  link-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - uses: actions/setup-node@v3
        with:
          node-version: 18

      - name: Install dependencies
        run: yarn install

      - name: Install playwright browsers
        run: yarn playwright install


      - name: Run crawler for PR (local build)
        if: github.event_name == 'pull_request'
        env:
          BASE_URL: "http://localhost:3000"
        run: |
          yarn build
          sleep 5
          echo "Starting local build..."
          yarn start & 
          sleep 10
          echo "Running link checker for local build at ${BASE_URL}"
          yarn tsx scripts/checkLinks.ts

      - name: Run crawler for deployed docs
        if: github.event_name != 'pull_request'
        env:
          BASE_URL: "https://www.docs.sei.io/"
        run: |
          echo "Running link checker for deployed docs at ${BASE_URL}"
          yarn tsx scripts/checkLinks.ts

      - name: Upload broken links artifact
        if: steps.crawler.outcome == 'failure'
        uses: actions/upload-artifact@v4
        with:
          name: broken-links
          path: brokenLinks.json

      - name: Fail job if crawler finds broken links
        if: steps.crawler.outcome == 'failure'
        run: exit 1