Skip to content

Commit bcf6ac5

Browse files
authored
Bring back github link checking (#2804)
* Bring back github link checking * sync with spec config * fix broken links * Exclude false positive * faster * GITHUB_TOKEN
1 parent 4b3de85 commit bcf6ac5

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

.github/workflows/reusable-markdown-link-check.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,6 @@ jobs:
1414

1515
- name: Run markdown-link-check
1616
run: make markdown-link-check
17+
env:
18+
# see https://lychee.cli.rs/troubleshooting/rate-limits/#github-rate-limiting
19+
GITHUB_TOKEN: ${{ github.token }}

.lychee.toml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
include_fragments = true
22

3-
# Accept 429 (rate limiting) to prevent failures
4-
accept = ["200..=299", "401", "403", "429"]
3+
accept = ["200..=299", "401", "403"]
54

65
exclude = [
76
# excluding links to user profiles is done for performance
87
# because there are a lot of links to user profiles in this repository
98
# and GitHub extra throttles access to user profile pages
109
"^https://github.com/[^/]+$",
10+
# this 404s when not hit from a browser
11+
"^https://www.linuxfoundation.org/legal/generative-ai$",
1112
]
1213

1314
exclude_path = [
@@ -26,9 +27,8 @@ exclude_path = [
2627
"/home/repo/elections/2024/governance-committee-election.md",
2728
]
2829

29-
# Retry configuration with more reasonable timeout values
30-
max_retries = 3
31-
# Wait time (in seconds) between retries with exponential backoff
32-
retry_wait_time = 1
33-
# Reduce number of concurrent requests to avoid triggering rate limits
34-
max_concurrency = 75
30+
# better to be safe and avoid failures
31+
max_retries = 6
32+
33+
# this helps slow down the rate of requests to avoid rate limiting
34+
max_concurrency = 16

guides/contributor/processes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,9 +209,9 @@ carry a permissive software license that is compatible when combining with
209209
Apache-2.0 License.
210210

211211
If you directly incorporate or vendor Apache-2.0 license compatible third-party code, follow
212-
the [CNCF Recommendations for Attribution Notices](https://github.com/cncf/foundation/blob/main/recommendations-for-attribution.md).
212+
the [CNCF Recommendations for Attribution Notices](https://github.com/cncf/foundation/blob/main/policies-guidance/recommendations-for-attribution.md).
213213

214-
The [CNCF Allowlist License Policy](https://github.com/cncf/foundation/blob/main/allowed-third-party-license-policy.md#cncf-allowlist-license-policy)
214+
The [CNCF Allowlist License Policy](https://github.com/cncf/foundation/blob/main/policies-guidance/allowed-third-party-license-policy.md#cncf-allowlist-license-policy)
215215
describes the requirements for depending on third-party code in CNCF codebases,
216216
along with a list of approved compatible licenses.
217217

0 commit comments

Comments
 (0)