Add Broken Link CI

[naher94]

Create a GitHub action that runs on a regular cadence scanning for dead links and prompts me so that I can fix them

• https://lychee.cli.rs
• https://talk.jekyllrb.com/t/how-to-check-for-un-linked-dead-files-in-site/7673
  • https://github.com/alshedivat/al-folio/blob/main/.github/workflows/broken-links-site.yml
• Link Checker Report #841
  • This is using the template from the repo readme which assumes a tags in html and markdown formats which doesn't work me this repo
• Dead Links Found - Link Checker Report #862 This one is getting closer

Future Updates

• Question: How can I scope the action to only a certain directory? lycheeverse/lychee-action#278
• Checkbox Formatting Option for Markdown Reports lycheeverse/lychee-action#274
  • Once Update To latest Release and add Checkbox Option (fixes #274) lycheeverse/lychee-action#279 is merged the checklist option should work
• Question: Excluding error codes lycheeverse/lychee-action#280

[naher94]

This works but check the whole repo not just the _site directory

name: Link Checker

on:
  repository_dispatch:
  workflow_dispatch:
  schedule:
    - cron: "00 18 * * *"

jobs:
  linkChecker:
    runs-on: ubuntu-latest
    permissions:
      issues: write # required for peter-evans/create-issue-from-file
    steps:
      - name: Checkout gh-pages branch
        uses: actions/checkout@v4
        with:
          ref: gh-pages

      - name: Set up Ruby
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: 3.0.0

      - name: Install Dependencies
        run: |
          gem install bundler
          bundle install

      - name: Build Jekyll site
        run: bundle exec jekyll build --trace

      - name: Filter files to check (include _site, exclude _site/css and _site/img)
        run: |
          # Find all files in _site, but exclude _site/css and _site/img
          find ./_site -type f | grep -vE '/(css|img)/' > files-to-check.txt
          cat files-to-check.txt

      - name: Link Checker
        id: lychee
        uses: lycheeverse/lychee-action@v2
        with:
          fail: false
          files: './files-to-check.txt'
          base: https://rehanbutt.com

      - name: Create Issue From File
        if: steps.lychee.outputs.exit_code != 0
        uses: peter-evans/create-issue-from-file@v5
        with:
          title: Dead Links Found - Link Checker Report
          content-filepath: ./lychee/out.md