Skip to content

Links

Links #245

Workflow file for this run

name: Links
on:
repository_dispatch:
workflow_dispatch:
schedule:
- cron: "0 0 * * 1"
jobs:
linkChecker:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Download Exclude Path
run: |
curl https://raw.githubusercontent.com/pingcap/docs/master/.lycheeignore --output .lycheeignore
- name: Restore lychee cache
uses: actions/cache@v4
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-
- name: Check Links
uses: lycheeverse/lychee-action@v2
with:
# For parameter description, see https://github.com/lycheeverse/lychee#commandline-parameters
fail: true
failIfEmpty: false
args: --root-dir $(pwd) --cache --max-cache-age 8d -E -i -n -t 45 --exclude-path '^releases/' --exclude-path '^tidb-cloud/releases/' -- **/*.md *.md
output: out.md
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
- name: Create Issue From File
uses: peter-evans/create-issue-from-file@v6
with:
title: Broken Link Detected
content-filepath: out.md
# - name: Fail if there were link errors
# run: exit ${{ steps.lychee.outputs.exit_code }}