name: Link check

on:
  schedule:
    - cron: '0 0 * * 1' # weekly on Monday
  workflow_dispatch:

permissions: {}

jobs:
  link-check:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      issues: write
    steps:
      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false

      - name: Check links
        id: lychee
        uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
        with:
          args: --no-progress --config .github/workflows/lychee.toml './docs/**/*.md' './*.md'
          fail: false

      - name: Open issue on broken links
        if: steps.lychee.outputs.exit_code != 0
        uses: peter-evans/create-issue-from-file@fca9117c27cdc29c6c4db3b86c48e4115a786710 # v6.0.0
        with:
          title: Broken links found in docs
          content-filepath: ./lychee/out.md
          labels: docs