Skip to content

Commit

Permalink
chore: setup link-check github action
Browse files Browse the repository at this point in the history
  • Loading branch information
qing authored and hyf0 committed Mar 12, 2024
1 parent 0e05190 commit 414c1a0
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/link-check.yml
@@ -0,0 +1,40 @@
name: Check Links

on:
workflow_dispatch:
push:
branches:
- main
paths:
- '**/*.md'
- '**/*.html'
pull_request:
types: [opened, synchronize]
paths:
- '**/*.md'
- '**/*.html'

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
cancel-in-progress: true

jobs:
check-links:
name: Check Links
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Check Links
uses: lycheeverse/lychee-action@master
with:
# For parameter description, see https://github.com/lycheeverse/lychee#commandline-parameters
# Accept 429 for now due to GitHub rate limit.
# See https://github.com/lycheeverse/lychee/issues/634
# Exclude twitter links, see https://github.com/lycheeverse/lychee/issues/1108.
# Ideally this is built in, by https://github.com/lycheeverse/lychee/pull/1147.
# Not sure why it doesn't work, exclude it manually.
args: --accept 200,429 --verbose --no-progress --exclude 'https://twitter\.com/*' .
# Fail action on broken links
fail: true

0 comments on commit 414c1a0

Please sign in to comment.