name: Broken Link Checker

permissions:
  contents: read

# runs on prs containing markdown or html changes, as well as every monday at 9 am
on:
  pull_request:
    paths:
      - "**.md"
      - "**.html"
  schedule:
    - cron: "0 9 * * 1"

jobs:
  link-checker:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install dependencies
        run: npm ci
      - name: Build Legal
        run: npm run license-report:html
      - uses: lycheeverse/lychee-action@c053181aa0c3d17606addfe97a9075a32723548a
        with:
          fail: true
          jobSummary: false
          args: --exclude-path 'node_modules' --verbose --no-progress './**/*.md' './**/*.html' './**/*.rst'