md-link-check.yml

name: Markdown Link Check

on:
  push:
  pull_request:
    branches:
    - master

permissions: {}

jobs:
  link-check:
    permissions:
      contents: read
      pull-requests: write
    runs-on: ubuntu-24.04
    env:
      CI: true
    steps:
    - name: Setup Action
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
    - name: Setup Node
      uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
      with:
        node-version: 20.x
    - name: Install dependencies
      run: npm ci --ignore-scripts
    - name: Run link check
      run: npm run link-check
    - name: Show broken links
      if: failure()
      run: |
        cat log | awk -v RS="FILE:" 'match($0, /(\S*\.md).*\[✖\].*(\d*\slinks\schecked\.)(.*)/, arr ) { print "FILE:"arr[1] arr[3] > "brokenlinks"}'
        rm -f err log
        cat brokenlinks
        links=`cat brokenlinks`
        links="${links//'%'/'%25'}"
        links="${links//$'\n'/'%0A'}"
        links="${links//$'\r'/'%0D'}"
        echo ::set-output name=links::**Following links are broken:** %0A$links
    - name: Send comment to PR with broken links
      if: failure() && github.event_name == 'pull_request'
      uses: thollander/actions-comment-pull-request@24bffb9b452ba05a4f3f77933840a6a841d1b32b # v3.0.1
      with:
        message: ${{ steps.brokenlinks.outputs.links }}
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}