check-links.yaml

name: Check broken links

on:
  deployment:
#   push:
#     branches:
#       - main

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install dependencies
        run: npm install -g linkinator

      - name: Check links
        run: linkinator https://docs.pimlico.io -r --format json > links-report.json

      - name: Prepare report
        id: prepare-report
        run: |
          LENGTH=$(jq '[.links[] | select(.state == "BROKEN")] | length' links-report.json)

          if [ "$LENGTH" -gt 0 ]; then
              echo "send_report=true" >> $GITHUB_OUTPUT
          else
              echo "send_report=false" >> $GITHUB_OUTPUT
          fi

          REPORT_LIST="$(jq '[.links[] | select(.state == "BROKEN" and .status == 404) | "• `\(.url)` (status: `\(.status)`) on the page \(.parent)"]' links-report.json)"
          echo "report_list=$REPORT_LIST" >> $GITHUB_OUTPUT

      - name: Send report
        uses: slackapi/slack-github-action@v1.26.0
        if: steps.prepare-report.outputs.send_report == 'true'
        with:
          channel-id: "#alerts-test"
          slack-message: |
            Broken links found in the docs:

            ${{ join(fromJson(steps.prepare-report.outputs.report_list), '\n') }}
          # payload: |
          #   {
          #       "text": "Report",
          #       "blocks": [
          #           {
          #               "type": "section",
          #               "text": {
          #               "type": "mrkdwn",
          #               "text": ${{ steps.prepare-report.outputs.report_list }}
          #               }
          #           }
          #       ]
          #   }
        env:
          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}