dead-link-check.yml

name: Link Checker

on:
  schedule:
    - cron: '0 3 * * 6' # Runs every day at 10 AM UTC
  push:
    branches:
      - gh-pages
      - development
  workflow_dispatch: # Allows manual trigger

jobs:
  link-check:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Run Lychee link checker
        id: lychee
        uses: lycheeverse/lychee-action@v1
        with:
          args: >-
            --verbose
            --accept 200,206
            --no-progress
            --require-https
            --max-concurrency 5
            --exclude "./_sass,./_site,./_vendor,./css,./img,./_config.yml,./README.md"
            --format json
            .
          output: ./lychee-report.json

      - name: Check if report exists
        id: check_report
        run: |
          if [ -f "./lychee-report.json" ]; then
            echo "Report found."
          else
            echo "Lychee report not found."
            exit 1
          fi

      - name: Upload Lychee report
        uses: actions/upload-artifact@v4
        with:
          name: lychee-report
          path: ./lychee-report.json
          retention-days: 7

      - name: Parse Dead Links & Create Issue
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          GITHUB_REPOSITORY: ${{ github.repository }}
          GITHUB_RUN_ID: ${{ github.run_id }}
          GITHUB_REPOSITORY_OWNER: ${{ github.repository_owner }}
          GITHUB_EVENT_REPOSITORY_NAME: ${{ github.event.repository.name }}
        run: |
          node - <<EOF
          const fs = require('fs');
          const path = './lychee-report.json';

          if (!fs.existsSync(path)) {
            console.log('No report found');
            process.exit(0);
          }

          let fileContent = fs.readFileSync(path, 'utf8').trim();

          try {
            // Extract valid JSON portion
            let firstCurlyBrace = fileContent.indexOf('{');
            let lastCurlyBrace = fileContent.lastIndexOf('}');
            if (firstCurlyBrace === -1 || lastCurlyBrace === -1) {
              throw new Error("Invalid JSON structure detected");
            }
            fileContent = fileContent.substring(firstCurlyBrace, lastCurlyBrace + 1);

            const report = JSON.parse(fileContent);

            if (!report.summary || report.summary.errors === 0) {
              console.log('No dead links found');
              process.exit(0);
            }

            console.log(`Found ${report.summary.errors} broken links`);

            let issueBody = "🚨 **Lychee found " + report.summary.errors + " broken links!**\n\n";
            issueBody += "| Status        | Count |\n|---------------|-------|\n";
            issueBody += "| 🔍 Total      | " + report.summary.total + "  |\n";
            issueBody += "| ✅ Successful | " + report.summary.successful + "  |\n";
            issueBody += "| ⏳ Timeouts   | " + report.summary.timeouts + "  |\n";
            issueBody += "| 🚫 Errors     | " + report.summary.errors + "  |\n\n";

            issueBody += "**Broken Links:**\n";
            report.links.forEach(link => {
              if (link.status !== 'OK') {
                issueBody += "- **" + link.url + "** (in **" + link.file + "**)\n";
              }
            });

            issueBody += `\n[Download Full Report](https://github.com/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID})`;

            const issueTitle = "🚨 Dead Links Found!";
            const { Octokit } = require("@octokit/core");
            const octokit = new Octokit({ auth: process.env.GITHUB_TOKEN });

            async function createIssue() {
              const { data: issues } = await octokit.request('GET /repos/' + process.env.GITHUB_REPOSITORY + '/issues', {
                owner: process.env.GITHUB_REPOSITORY_OWNER,
                repo: process.env.GITHUB_EVENT_REPOSITORY_NAME,
                state: 'open',
                labels: 'dead-link-alert'
              });

              if (!issues.some(issue => issue.title === issueTitle)) {
                console.log("Creating GitHub issue...");
                await octokit.request('POST /repos/' + process.env.GITHUB_REPOSITORY + '/issues', {
                  owner: process.env.GITHUB_REPOSITORY_OWNER,
                  repo: process.env.GITHUB_EVENT_REPOSITORY_NAME,
                  title: issueTitle,
                  body: issueBody,
                  labels: ["dead-link-alert"]
                });
              } else {
                console.log("Issue already exists.");
              }
            }

            createIssue().catch(error => console.error(error));
          } catch (error) {
            console.log("Error parsing lychee-report.json. It might not be in JSON format.");
            console.log("File content:\n", fileContent);
          }
          EOF