Skip to content
Open
Changes from 1 commit
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
106 changes: 88 additions & 18 deletions .github/workflows/lychee.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,29 @@

# Verbose program output
# Accepts log level: "error", "warn", "info", "debug", "trace"
#verbose = "warn"
verbose = "warn"

# Output format
format = "detailed"

# Output display mode
mode = "emoji"

# Don't show interactive progress bar while checking links.
no_progress = false

# Path to summary output file.
output = ".github/link_report.md"

# Show host statistics
host_stats = true

# Extract links instead of checking them
dump = true

# Dump inputs instead of doing link extraction / checking
dump_inputs = true

############################# Cache ###############################

# Enable link caching. This can be helpful to avoid checking the same links on
Expand All @@ -19,8 +34,14 @@ cache = true
# Discard all cached requests older than this duration.
max_cache_age = "1d"

# A list of status codes that will be ignored from the cache
cache_exclude_status = "500.."

############################# Runtime #############################

# File to read and write cookies
cookie_jar = "cookie-jar"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's comment out bits that aren't relevant for us.

Suggested change
cookie_jar = "cookie-jar"
# cookie_jar = "cookie-jar"


# Number of threads to utilize.
# Defaults to number of cores available to the system if omitted.
threads = 2
Expand All @@ -34,6 +55,18 @@ max_retries = 2
# Maximum number of concurrent link checks.
max_concurrency = 14

# extension applied to files without extension
default_extension = "md"

# GitHub API token
github_token = "secret"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
github_token = "secret"
# github_token = "secret"


# Resolve directories to index files
index_files = ["index.html"]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
index_files = ["index.html"]
# index_files = ["index.html"]


# Preprocess input files
preprocess = { command = "preprocess.sh" }
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
preprocess = { command = "preprocess.sh" }
# preprocess = { command = "preprocess.sh" }


############################# Requests ############################

# User agent to send with each request.
Expand All @@ -46,14 +79,21 @@ timeout = 20
retry_wait_time = 2

# Comma-separated list of accepted status codes for valid links.
accept = [200, 429]
# Supported values are:
#
# accept = ["200..=204", "429"]
# accept = "200..=204, 429"
# accept = ["200", "429"]
# accept = "200, 429"
accept = ["200", "429"]

# Proceed for server connections considered insecure (invalid TLS).
insecure = false

# Only test links with the given schemes (e.g. https).
# Omit to check links with any scheme.
scheme = [ "https" ]
# Omit to check links with any other scheme.
# At the moment, we support http, https, file, and mailto.
scheme = ["https"]

# When links are available using HTTPS, treat HTTP links as errors.
require_https = false
Expand All @@ -62,45 +102,62 @@ require_https = false
method = "get"

# Custom request headers
headers = []
header = { "accept" = "text/html", "x-custom-header" = "value" }
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need a custom header here. 👍🏻

Suggested change
header = { "accept" = "text/html", "x-custom-header" = "value" }
header = { "accept" = "text/html" }


# Remap URI matching pattern to different URI.
remap = [ "https://example.com http://example.invalid" ]
remap = ["https://example.com http://example.invalid"]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
remap = ["https://example.com http://example.invalid"]
# remap = ["https://example.com http://example.invalid"]


# 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", "html"]

# Base URL or website root directory to check relative URLs.
#base = "https://pestphp.com"
#base_url = "https://pestphp.com"

# Enable the checking of fragments in links.
include_fragments = true

# HTTP basic auth support. This will be the username and password passed to the
# authorization HTTP header. See
# <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization>
#basic_auth = ["example.com user:pwd"]
# Minimum accepted TLS Version
min_tls = "TLSv1_3"

############################# Exclusions ##########################

# Skip missing input files (default is to error if they don't exist).
skip_missing = false

# Do not skip hidden directories and files
hidden = true

# Do not skip files that are ignored
no_ignore = true

# Check links inside `<code>` and `<pre>` blocks as well as Markdown code
# blocks.
include_verbatim = false

# Ignore case of paths when matching glob patterns.
glob_ignore_case = false

# Exclude URLs and mail addresses from checking (supports regex).
# receiving forbidden but valid link, receiving timeout but valid link
# Exclude URLs and mail addresses from checking. The values are treated as regular expressions
exclude = [
'https://opensource.org/licenses/MIT',
'https://twitter.com/pestphp',
'^https://laracasts.com/series/(pest-driven-laravel|pest-from-scratch)$',
'^https://www.linkedin.com/learning/.*$',
]

# Exclude these filesystem paths from getting checked.
#exclude_path = ["file/path/to/Ignore", "./other/file/path/to/Ignore"]
# Exclude paths from getting checked. The values are treated as regular expressions
#exclude_path = [
# "\\.txt$", # skip .txt extensions
# "(^|/)test/", # skip directories named "test"
# "[aeiouAEIOU]", # exclude paths containing vowels
#]

# Check the specified file extensions
extensions = ["md"]

# URLs to check (supports regex). Has preference over all excludes.
#include = [ 'gist\.github\.com.*' ]
#include = ['gist\.github\.com.*']

# Exclude all private IPs from checking.
# Equivalent to setting `exclude_private`, `exclude_link_local`, and
Expand All @@ -116,6 +173,19 @@ exclude_link_local = false
# Exclude loopback IP address range and localhost from checking.
exclude_loopback = false

# Exclude all mail addresses from checking.
exclude_mail = false
# Check mail addresses
include_mail = false

# Check WikiLinks in Markdown files
include_wikilinks = true

# Only check local files
#offline = true

############################# Hosts #############################

# Maximum simultaneous requests to the same host
host_concurrency = 5

# Minimum interval between requests to the same host
host_request_interval = "50ms"
Loading