-
Notifications
You must be signed in to change notification settings - Fork 1.7k
chore(link checker): Move to Lychee for link checking #889
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
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
8d9e49a
chore(package.json): add angular commit helper deps and script
JimMadge b9ab75a
test(link checking): add lychee configuration
JimMadge ca137de
test(link check): add script to check links in Markdown source
JimMadge e7543fc
fix: correct link to eslint commit convention
JimMadge 06f7874
fix: correct bot usage image path
JimMadge e4be135
test: add mdx to fallback extentions
JimMadge a63c7bd
fix: remove broken link
JimMadge 4b7c9bd
test: check links internal to a page
JimMadge 34b84d7
test: add root dir to link checking
JimMadge 780c08b
ci: add markdownlint dep and script
JimMadge c7ffcb4
style: fix linting errors
JimMadge df9525f
ci: install deps for lint workflow
JimMadge ceee9b1
ci: add offline link check for PRs and push to main
JimMadge File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
name: Offline link check | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
|
||
jobs: | ||
link_check: | ||
runs-on: ubuntu-latest | ||
steps: | ||
uses: actions/checkout@v5 | ||
uses: lycheeverse/lychee-action@v2 | ||
# Only check local files, no network requests | ||
args: --offline --no-progress 'src/content/docs/**/*.md' | ||
# Fail job when lychee returns a non-zero exit code | ||
fail: true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
############################# Display ############################# | ||
|
||
# Verbose program output | ||
# Accepts log level: "error", "warn", "info", "debug", "trace" | ||
verbose = "info" | ||
|
||
# Don't show interactive progress bar while checking links. | ||
no_progress = false | ||
|
||
############################# Cache ############################### | ||
|
||
# Enable link caching. This can be helpful to avoid checking the same links on | ||
# multiple runs. | ||
cache = true | ||
|
||
# Discard all cached requests older than this duration. | ||
max_cache_age = "2d" | ||
|
||
############################# Runtime ############################# | ||
|
||
# Number of threads to utilize. | ||
# Defaults to number of cores available to the system if omitted. | ||
threads = 2 | ||
|
||
# Maximum number of allowed redirects. | ||
max_redirects = 10 | ||
|
||
# Maximum number of allowed retries before a link is declared dead. | ||
max_retries = 2 | ||
|
||
# Maximum number of concurrent link checks. | ||
max_concurrency = 14 | ||
|
||
############################# Requests ############################ | ||
|
||
# When links are available using HTTPS, treat HTTP links as errors. | ||
require_https = true | ||
|
||
# Fallback extensions to apply when a URL does not specify one. | ||
# This is common in documentation tools that cross-reference files without extensions. | ||
fallback_extensions = ["md", "mdx", "html"] | ||
|
||
############################# Exclusions ########################## | ||
|
||
# Exclude URLs and mail addresses from checking. The values are treated as regular expressions | ||
exclude = [] | ||
|
||
# Check fragments - internal links in pages | ||
include_fragments = true | ||
|
||
# Check email addresses | ||
include_mail = true |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.