Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configure Lychee to ignore localhost and Rancher URLs #196

Merged
merged 1 commit into from
Feb 21, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions .github/workflows/check-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,24 @@ jobs:
id: lychee
uses: lycheeverse/lychee-action@v2
with:
# Note: The `--format` option refers to the format of the report, not the documents being scanned.
#
# Notes:
# - The `>` symbol tells the YAML parser to replace newlines with whitespace. This way, we don't
# have to terminate each line with a `\` character to escape the invisible newline character.
# - The `--format` option refers to the format of the report, not the documents being scanned.
# - The `--exclude-loopback` option makes it so Lychee does not check "localhost" URLs.
# - The `--exclude <PATTERN>` option can be used multiple times.
#
# Reference: https://github.com/lycheeverse/lychee#commandline-parameters
args: --base '_build/html' --verbose --no-progress --format markdown '_build/html/**/*.html'
#
args: >
--base '_build/html'
--exclude-loopback
--exclude '^https://rancher2.spin.nersc.gov'
--verbose
--no-progress
--format markdown
'_build/html/**/*.html'
debug: true
output: ./lychee/out.md
fail: false
Expand Down