docs.yml

name: Docs

on:
  push:
    branches: [main]
    paths: ['**/*.md']
  pull_request:
    branches: [main]
    paths: ['**/*.md']
  workflow_dispatch:

jobs:
  markdown-link-check:
    name: Markdown Link Check
    runs-on: ubuntu-latest
    
    permissions:
      contents: read
      issues: write
      pull-requests: write

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

      - name: Check markdown links
        uses: lycheeverse/lychee-action@v2.2.0
        with:
          args: >-
            --verbose
            --no-progress
            --accept 200,206
            --timeout 20
            --max-retries 3
            --max-concurrency 10
            --user-agent 'Mozilla/5.0 (compatible; LinkChecker/1.0)'
            --exclude 'http://localhost.*'
            --exclude-path '.git'
            --exclude-path 'build'
            --exclude-path 'vendor'
            --exclude-mail
            '**/*.md'
          fail: true
          jobSummary: true
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}