Skip to content
validate-documentation

ci(validate-documentation): add caching for lychee #3126

Sign in to view logs

ci(validate-documentation): add caching for lychee

ci(validate-documentation): add caching for lychee #3126

Workflow file for this run

.github/workflows/validate-documentation.yml at ad7ca60
name: validate-documentation
on:
push:
branches: [ main ]
paths:
- '.github/workflows/validate-documentation.yml'
- '**.md'
- '.lycheeignore'
pull_request:
branches: [ main ]
paths:
- '.github/workflows/validate-documentation.yml'
- '**.md'
- '.lycheeignore'
merge_group:
workflow_dispatch:
permissions:
contents: read
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # tag: v4.2.2
- name: Restore lychee cache
uses: actions/cache/restore@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
id: cache-restore
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-
- name: Run markdown links checks
if: ${{ !contains(github.event.pull_request.labels.*.name, 'release PR') }}
uses: lycheeverse/lychee-action@82202e5e9c2f4ef1a55a3d02563e1cb6041e5332 # tag: v2.4.1
with:
fail: true
args: "--cache --max-cache-age 1d --threads 1 --max-concurrency 1 --verbose --retry-wait-time 5 --max-retries 3 --timeout 60 --no-progress './**/*.md' './**/*.html'"
- name: Run markdownlint
uses: streetsidesoftware/cspell-action@69543c3f9f14d4fcc6004c7bee03c4d366f11d64 # tag: v7.0.1
with:
files: '**/*.md'
- name: Run cspell
uses: DavidAnson/markdownlint-cli2-action@992badcdf24e3b8eb7e87ff9287fe931bcb00c6e # tag: v20.0.0
- name: Save lychee cache
if: always()
uses: actions/cache/save@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
with:
path: .lycheecache
key: ${{ steps.cache-restore.outputs.cache-primary-key }}