check-links.yml

name: Check Links

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  link-checker:
    name: Check Documentation Links
    runs-on: ubuntu-latest
    permissions:
      contents: read
      issues: write

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Check links with lychee
        uses: lycheeverse/lychee-action@v2
        with:
          # Use configuration file for path remapping and settings
          args: >-
            --config lychee.toml
            'content/**/*.md'
            'content/**/*.mdx'
            'README.md'
          # Fail the job if broken links are found
          fail: true
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Create Issue on Failure
        if: failure()
        uses: actions/github-script@v7
        with:
          script: |
            github.rest.issues.create({
              owner: context.repo.owner,
              repo: context.repo.repo,
              title: '🔗 Broken links detected in documentation',
              body: `Link checker found broken links in the documentation.\n\nPlease review the [workflow run](${context.payload.repository.html_url}/actions/runs/${context.runId}) for details.`,
              labels: ['documentation', 'bug']
            });