← 中文资源

简体中文版本

在 CI 中检查运维手册链接

定时用 lychee 扫描 runbook 中的链接,在事故来临前修复失效的面板、Wiki 与告警链接。

阅读英文原文

概述

运维手册通常在压力下使用,没有时间再去搜索新的面板地址。一个失效链接会把有记录的恢复流程变成临场发挥。链接检查成本低、结果确定,能发现最常见的文档故障:资源被移动或删除而引用没有更新。

步骤

  1. 添加 .lychee.toml,设置超时、重试与可接受的响应码:
max_concurrency = 8
timeout = 20
max_retries = 2
accept = [200, 204, 301, 302, 403]
  1. 本地运行 lychee --config .lychee.toml 'docs/runbooks/**/*.md',逐条查看失败链接及所在文件行号。
  2. 在 CI 中使用 lychee-action,设置 fail: true,并在文档变更的 PR 和周定时任务中各运行一次。
  3. 需要 SSO 的链接加入 .lycheeignore,同时记录原因与负责人,每季度复核。

验证

预期 PR 中新增死链会让 CI 失败并输出具体 URL;周任务能发现无人修改文件中的外部链接失效。所有排除项都有记录,排除后本地运行通过。

注意事项

  • SSO 后面的链接无法由 CI 验证,只能人工抽查。
  • 页面可访问不代表内容仍然正确,链接检查只验证可用性。
  • 不要为了通过检查而把 fail 改为警告,那等于放弃门禁。
  • 内网面板响应慢时应调高超时和重试,而不是排除整个域名。