pipe-cd/pipecd

ci(docs): Add link checker to existing CI to prevent broken docs links

Open

#6,549 opened on Feb 26, 2026

View on GitHubContributor guide
 (6 comments) (1 reaction) (1 assignee)Go (319 forks)auto 404
area/cigood first issuetype/feature

Repository metrics

Stars
 (1,329 stars)
PR merge metrics
 (PR metrics pending)

Description

Add a lightweight link-checking step to the existing CI workflow that runs only when docs or README files change. This would fail PRs if there are broken external links, helping catch issues early and reducing manual review overhead for maintainers.

What would you like to be added:

Why is this needed:

Contributor guide

Research direction
Inspect the existing CI workflow files in the .github/workflows directory. Identify the workflow that builds or tests documentation. Research link checker tools like lychee or markdown link check, and learn how to add a new step that runs only on docs/README changes. Understand how to ensure the check fails on broken links.
Tech stack
github actions
Domain
ci cddevops
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitGitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75