pipe-cd/pipecd

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

开放

#6,549 创建于 2026年2月26日

在 GitHub 查看贡献者指南
 (6 条评论) (1 个反应) (1 位负责人)Go (319 个派生)auto 404
area/cigood first issuetype/feature

仓库指标

星标
 (1,329 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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:

贡献者指南

研究方向
检查 .github/workflows 目录中现有的 CI 工作流文件。确定用于构建或测试文档的工作流。研究链接检查工具，如 lychee 或 markdown link check，并了解如何添加一个仅在 docs/README 更改时运行的新步骤。了解如何确保检查在遇到损坏的链接时失败。
技术栈
github actions
领域
ci cddevops
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
基本清晰
前置要求
GitGitHub Actions
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75