check_links.yml

name: Check Links

on:
  pull_request:
    branches: 
      - master
      - main
  workflow_dispatch:

jobs:

  generate-matrix:
    name: Find markdown files to check
    runs-on: ubuntu-latest
    outputs:
      matrix: ${{ steps.set-matrix.outputs.matrix }}
    steps:
      - uses: actions/checkout@v4
      - id: set-matrix
        run: |
          set -x
          echo "matrix=$(find "$(pwd)" -type f -iname \*.md | jq -R -s -c 'split("\n")[:-1]')" >> $GITHUB_OUTPUT

  check:
    runs-on: ubuntu-latest
    needs: [generate-matrix]
    strategy:
      fail-fast: false
      matrix:
        file_to_check: ${{ fromJson(needs.generate-matrix.outputs.matrix) }}
    steps:

    - name: Install markdown-link-check
      run: sudo npm install -g markdown-link-check

    - uses: actions/checkout@v4

    - name: Run markdown-link-check against *.md files
      run: markdown-link-check --config "$(pwd)/.markdown-link-check.json" --verbose --quiet "${{ matrix.file_to_check }}"