Skip to content

Link Check

Link Check #24

Workflow file for this run

---
name: "Link Check"
on: # yamllint disable-line rule:truthy
workflow_dispatch:
schedule:
- cron: "0 0 * * 0"
env:
WORKFLOW_ISSUE_TITLE: "Link Checker Dashboard 🔗"
jobs:
link-check:
name: Link Check
runs-on: ubuntu-latest
steps:
- name: Generate Token
uses: actions/create-github-app-token@5d869da34e18e7287c1daad50e0b8ea0f506ce69 # v1
id: app-token
with:
app-id: "${{ secrets.BOT_APP_ID }}"
private-key: "${{ secrets.BOT_APP_PRIVATE_KEY }}"
- name: Checkout
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
with:
token: "${{ steps.app-token.outputs.token }}"
- name: Restore lychee cache
uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-
- name: Setup Homebrew
uses: Homebrew/actions/setup-homebrew@master
- name: Setup Workflow Tools
shell: bash
run: brew install lychee
- name: Scan For Broken Links
shell: bash
env:
GITHUB_TOKEN: "${{ steps.app-token.outputs.token }}"
run: |
lychee --verbose --no-progress \
--format markdown \
--output results.md \
--exclude-all-private \
--exclude-mail \
./**/*.md || true
- name: Print Output
run: cat results.md
- name: Find Link Checker Issue
id: find-issue
shell: bash
env:
GH_TOKEN: "${{ steps.app-token.outputs.token }}"
run: |
issue_number=$( \
gh issue list \
--search "in:title ${{ env.WORKFLOW_ISSUE_TITLE }}" \
--state open \
--json number \
| jq --raw-output '.[0].number' \
)
echo "issue-number=${issue_number}" >> $GITHUB_OUTPUT
echo "${issue_number}"
- name: Create or Update Issue
uses: peter-evans/create-issue-from-file@e8ef132d6df98ed982188e460ebb3b5d4ef3a9cd # v5
with:
token: "${{ steps.app-token.outputs.token }}"
title: "${{ env.WORKFLOW_ISSUE_TITLE }}"
issue-number: "${{ steps.find-issue.outputs.issue-number || '' }}"
content-filepath: results.md