ci-links.yml

# NOTE: This name appears in GitHub's Checks API and in workflow's status badge.
name: ci-links

on:
  schedule:
    # Check for broken links every day at 7:00 AM.
    - cron:  '0 7 * * *'

jobs:
  links:
    # NOTE: This name appears in GitHub's Checks API.
    name: links
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v5
        with:
          submodules: true
      - name: Set up Node.js
        uses: actions/setup-node@v5
        with:
          node-version: '20.x'
          cache: yarn
      - name: Build
        env:
          # Docs will be served on localhost. Rewrite the host URL.
          URL: http://localhost:3000
        run: |
          yarn install --frozen-lockfile
          yarn build
      - name: Serve
        run: |
          yarn serve &
      - name: Check links
        run: |
          yarn blc