From a4172f06ea07a90cbe3df0a70dacd2d374e840e4 Mon Sep 17 00:00:00 2001
From: Victoria <4222953+lvpeschke@users.noreply.github.com>
Date: Wed, 26 Jun 2024 13:11:45 +0200
Subject: [PATCH] feat: add a CI workflow for detecting broken links (#1340)

Set up following the instructions at https://github.com/marketplace/actions/lychee-broken-link-checker.

The workflow will scan the repository weekly for broken links and create issues if it finds any.
---
 .github/workflows/links.yml | 24 ++++++++++++++++++++++++
 1 file changed, 24 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 0000000000..a75d7bf4b7
--- /dev/null
+++ b/.github/workflows/links.yml
@@ -0,0 +1,24 @@
+name: Check Broken Links
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 5 * * SUN" # at 5am on Sundays
+
+jobs:
+  linkChecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@v1
+
+      - name: Create Issue From File
+        if: env.lychee_exit_code != 0
+        uses: peter-evans/create-issue-from-file@v4
+        with:
+          title: Link Checker Report
+          content-filepath: ./lychee/out.md
+          labels: bug, automated issue