Skip to content

Add automated broken link checking for documentation#7399

Open
ShivamJha2436 wants to merge 2 commits intoprojectcontour:mainfrom
ShivamJha2436:docs-broken-link-checker
Open

Add automated broken link checking for documentation#7399
ShivamJha2436 wants to merge 2 commits intoprojectcontour:mainfrom
ShivamJha2436:docs-broken-link-checker

Conversation

@ShivamJha2436
Copy link
Contributor

Summary

This PR adds an automated broken-link checker for Contour documentation using the Lychee GitHub Action.

Behavior

  • Runs on pull requests that modify files under site/content/docs/main
  • Runs weekly on a scheduled basis to detect documentation link rot
  • Generates a Markdown report of broken links
  • Automatically opens a GitHub issue on scheduled failures
  • Prevents duplicate issue spam by checking for an existing open issue first

Why

Broken links in documentation negatively impact users and contributors.
This workflow provides early detection while keeping CI cost low by scanning only the actively maintained main docs.

Files Added

  • .github/workflows/docs-link-check.yml
  • .lycheeignore

Signed-off-by: ShivamJha2436 <shivamkumar87148@gmail.com>
@ShivamJha2436 ShivamJha2436 requested a review from a team as a code owner February 4, 2026 17:26
@ShivamJha2436 ShivamJha2436 requested review from sunjayBhatia and tsaarni and removed request for a team February 4, 2026 17:26
@sunjayBhatia sunjayBhatia requested review from a team, rajatvig and wilsonwu and removed request for a team February 4, 2026 17:26
@codecov
Copy link

codecov bot commented Feb 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.77%. Comparing base (d368385) to head (0ee4bfe).
⚠️ Report is 17 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #7399      +/-   ##
==========================================
- Coverage   81.85%   81.77%   -0.09%     
==========================================
  Files         130      130              
  Lines       15766    15766              
==========================================
- Hits        12906    12893      -13     
  Misses       2576     2576              
- Partials      284      297      +13     

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@tsaarni tsaarni added the release-note/none-required Marks a PR as not requiring a release note. Should only be used for very small changes. label Feb 4, 2026
Signed-off-by: ShivamJha2436 <shivamkumar87148@gmail.com>
@github-actions
Copy link

github-actions bot commented Mar 8, 2026

The Contour project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 30d of inactivity, lifecycle/stale is applied
  • After 60d of inactivity since lifecycle/stale was applied, the PR is closed

You can:

  • Ensure your PR is passing all CI checks. PRs that are fully green are more likely to be reviewed. If you are having trouble with CI checks, reach out to the #contour channel in the Kubernetes Slack workspace.
  • Mark this PR as fresh by commenting or pushing a commit
  • Close this PR
  • Offer to help out with triage

Please send feedback to the #contour channel in the Kubernetes Slack

@github-actions github-actions bot added lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Mar 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release-note/none-required Marks a PR as not requiring a release note. Should only be used for very small changes.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants