Skip to content

Commit b962b17

Browse files
authored
Merge pull request #6312 from influxdata/jts-link-checker
test: validate link-checker workflow
2 parents d8095f5 + a8578bb commit b962b17

File tree

18 files changed

+579
-1482
lines changed

18 files changed

+579
-1482
lines changed

.ci/link-checker/default.lycherc.toml

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Lychee link checker configuration
2+
# Generated by link-checker
3+
[lychee]
4+
# Performance settings
5+
6+
# Maximum number of retries for failed checks
7+
8+
max_retries = 3
9+
10+
# Timeout for each link check (in seconds)
11+
timeout = 30
12+
13+
# Maximum number of concurrent checks
14+
max_concurrency = 128
15+
16+
skip_code_blocks = false
17+
18+
# HTTP settings
19+
# Identify the tool to external services
20+
user_agent = "Mozilla/5.0 (compatible; link-checker)"
21+
22+
# Accept these HTTP status codes as valid
23+
accept = [200, 201, 202, 203, 204, 206, 301, 302, 303, 304,
24+
307, 308]
25+
26+
# Skip these URL schemes
27+
scheme = ["file", "mailto", "tel"]
28+
29+
# Exclude patterns (regex supported)
30+
exclude = [
31+
# Localhost URLs
32+
"^https?://localhost",
33+
"^https?://127\\.0\\.0\\.1",
34+
35+
# Common CI/CD environments
36+
"^https?://.*\\.local",
37+
38+
# Example domains used in documentation
39+
"^https?://example\\.(com|org|net)",
40+
41+
# Placeholder URLs from code block filtering
42+
"https://example.com/REMOVED_FROM_CODE_BLOCK",
43+
"example.com/INLINE_CODE_URL",
44+
45+
# URLs that require authentication
46+
"^https?://.*\\.slack\\.com",
47+
"^https?://.*\\.atlassian\\.net",
48+
49+
# GitHub URLs (often fail due to rate limiting and bot
50+
# detection)
51+
"^https?://github\\.com",
52+
53+
# Common documentation placeholders
54+
"YOUR_.*",
55+
"REPLACE_.*",
56+
"<.*>",
57+
]
58+
59+
# Request headers
60+
[headers]
61+
# Add custom headers here if needed
62+
# "Authorization" = "Bearer $GITHUB_TOKEN"
63+
64+
# Cache settings
65+
cache = true
66+
max_cache_age = "1d"
Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# Production Link Checker Configuration for InfluxData docs-v2
2+
# Optimized for performance, reliability, and reduced false positives
3+
[lychee]
4+
# Performance settings
5+
6+
# Maximum number of retries for failed checks
7+
8+
max_retries = 3
9+
10+
# Timeout for each link check (in seconds)
11+
timeout = 30
12+
13+
# Maximum number of concurrent checks
14+
max_concurrency = 128
15+
16+
skip_code_blocks = false
17+
18+
# HTTP settings
19+
# Identify the tool to external services
20+
"User-Agent" = "Mozilla/5.0 (compatible; influxdata-link-checker/1.0; +https://github.com/influxdata/docs-v2)"
21+
accept = [200, 201, 202, 203, 204, 206, 301, 302, 303, 304, 307, 308]
22+
23+
# Skip these URL schemes
24+
scheme = ["mailto", "tel"]
25+
26+
# Performance optimizations
27+
cache = true
28+
max_cache_age = "1h"
29+
30+
# Retry configuration for reliability
31+
include_verbatim = false
32+
33+
# Exclusion patterns for docs-v2 (regex supported)
34+
exclude = [
35+
# Localhost URLs
36+
"^https?://localhost",
37+
"^https?://127\\.0\\.0\\.1",
38+
39+
# Common CI/CD environments
40+
"^https?://.*\\.local",
41+
42+
# Example domains used in documentation
43+
"^https?://example\\.(com|org|net)",
44+
45+
# Placeholder URLs from code block filtering
46+
"https://example.com/REMOVED_FROM_CODE_BLOCK",
47+
"example.com/INLINE_CODE_URL",
48+
49+
# URLs that require authentication
50+
"^https?://.*\\.slack\\.com",
51+
"^https?://.*\\.atlassian\\.net",
52+
53+
# GitHub URLs (often fail due to rate limiting and bot
54+
# detection)
55+
"^https?://github\\.com",
56+
57+
# Social media URLs (often block bots)
58+
"^https?://reddit\\.com",
59+
"^https?://.*\\.reddit\\.com",
60+
61+
# InfluxData support URLs (certificate/SSL issues in CI)
62+
"^https?://support\\.influxdata\\.com",
63+
64+
# Common documentation placeholders
65+
"YOUR_.*",
66+
"REPLACE_.*",
67+
"<.*>",
68+
]
69+
70+
# Request headers
71+
[headers]
72+
# Add custom headers here if needed
73+
# "Authorization" = "Bearer $GITHUB_TOKEN"
74+
"Accept" = "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
75+
"Accept-Language" = "en-US,en;q=0.5"
76+
"Accept-Encoding" = "gzip, deflate"
77+
"DNT" = "1"
78+
"Connection" = "keep-alive"
79+
"Upgrade-Insecure-Requests" = "1"
80+
81+
[ci]
82+
# CI-specific settings
83+
84+
[ci.github_actions]
85+
output_format = "json"
86+
create_annotations = true
87+
fail_fast = false
88+
max_annotations = 50 # Limit to avoid overwhelming PR comments
89+
90+
[ci.performance]
91+
# Performance tuning for CI environment
92+
parallel_requests = 32
93+
connection_timeout = 10
94+
read_timeout = 30
95+
96+
# Resource limits
97+
max_memory_mb = 512
98+
max_execution_time_minutes = 10
99+
100+
[reporting]
101+
# Report configuration
102+
include_fragments = false
103+
verbose = false
104+
no_progress = true # Disable progress bar in CI
105+
106+
# Summary settings
107+
show_success_count = true
108+
show_skipped_count = true

.github/actions/report-broken-links/action.yml

Lines changed: 0 additions & 103 deletions
This file was deleted.

.github/actions/validate-links/action.yml

Lines changed: 0 additions & 106 deletions
This file was deleted.

0 commit comments

Comments
 (0)