Skip to content

Commit

Permalink
feat: add a CI workflow for detecting broken links (#1340)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
lvpeschke authored Jun 26, 2024
1 parent ce19c90 commit a4172f0
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/links.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit a4172f0

Please sign in to comment.