mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-29 17:07:22 +00:00
47 lines
1.3 KiB
YAML
47 lines
1.3 KiB
YAML
name: docs
|
|
|
|
on:
|
|
pull_request:
|
|
paths:
|
|
- "docs/**"
|
|
- "*.md"
|
|
branches:
|
|
- main
|
|
- 3.x
|
|
|
|
# Remove default permissions of GITHUB_TOKEN for security
|
|
# https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs
|
|
permissions: {}
|
|
|
|
jobs:
|
|
link-checker:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
# Cache lychee results (e.g. to avoid hitting rate limits)
|
|
- name: Restore lychee cache
|
|
uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4.1.2
|
|
with:
|
|
path: .lycheecache
|
|
key: cache-lychee-${{ github.sha }}
|
|
restore-keys: cache-lychee-
|
|
|
|
# check links with Lychee
|
|
- uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
|
|
|
|
- name: Lychee link checker
|
|
uses: lycheeverse/lychee-action@7cd0af4c74a61395d455af97419279d86aafaede # for v1.8.0
|
|
with:
|
|
# arguments with file types to check
|
|
args: >-
|
|
--cache
|
|
--verbose
|
|
--no-progress
|
|
--max-cache-age=1d
|
|
'./**/*.md'
|
|
'./**/*.html'
|
|
# fail the action on broken links
|
|
fail: true
|
|
env:
|
|
# to be used in case rate limits are surpassed
|
|
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
|