lychee.yml

name: Check Markdown links

on:
  workflow_dispatch:
  schedule:
    - cron: '18 * * *' # Run once daily at 18:00 UTC

jobs:
  check-links:
    runs-on: ubuntu-latest
    permissions:
      issues: write # required for peter-evans/create-issue-from-file
    steps:
      - uses: actions/checkout@v4

      - name: Restore lychee cache
        uses: actions/cache@v4
        with:
          path: .lycheecache
          key: cache-lychee-${{ github.sha }}
          restore-keys: cache-lychee-

      - name: Link Checker
        id: lychee
        uses: lycheeverse/lychee-action@v2
        with:
          args: --base . --verbose --no-progress './docs/*.md'
          token: ${{ secrets.CUSTOM_TOKEN }}
          fail: false

      - name: Create Issue From File
        if: ${{ steps.lychee.outputs.exit_code }} != 0
        uses: peter-evans/create-issue-from-file@v5
        with:
          title: Link Checker Report
          content-filepath: ./lychee/out.md
          labels: lychee