From b2eff8cf9919975571ee7eb53ef083fc4a1d8635 Mon Sep 17 00:00:00 2001
From: JJ Brosnan <84038776+jjbrosnan@users.noreply.github.com>
Date: Fri, 25 Oct 2024 08:17:34 -0400
Subject: [PATCH] ci: Add link checking to CI (#6168)

Rather than integrate the docs tool, this uses
https://github.com/lycheeverse/lychee-action?tab=readme-ov-file.

It will file a ticket if there are broken links. If that's not the best
way, it can be made to notify Slack instead.
---
 .github/workflows/links.yml | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 .github/workflows/links.yml

diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml
new file mode 100644
index 00000000000..1ffd417dbab
--- /dev/null
+++ b/.github/workflows/links.yml
@@ -0,0 +1,25 @@
+name: Links
+
+on:
+  repository_dispatch:
+  workflow_dispatch:
+  schedule:
+    - cron: "00 18 * * *"
+
+jobs:
+  linkChecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@v2
+
+      - name: Create Issue From File
+        if: env.lychee_exit_code != 0
+        uses: peter-evans/create-issue-from-file@v5
+        with:
+          title: Link Checker Report
+          content-filepath: ./lychee/out.md
+          labels: report, automated issue