Agent Skills
返回列表
💻

Helm Chart 文档生成器

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/regenerate-helm-chart-readmes-from-values-and-comments-before-release。

技能介绍

它解决什么问题

Helm chart 的 README 往往是手工维护的:你在 values.yaml 里改了参数名、删了字段、调了默认值,参数表格却还停留在上一次写文档时的样子。等到发版,文档写着 A、实际部署值是 B,排查成本最终由使用者承担。这类文档漂移很难在 review 里被发现,因为 diff 看起来只是「改了几行说明」。

技能如何工作

它在提交或发布前调用 helm-docs,把 Chart.yaml、values.yaml 和行内注释重新渲染成 README:

  • 从 values 和注释重建参数表格,不再手工抄录每个键,避免遗漏或漏改;
  • 输出可 review 的 diff:表格变更、缺失的描述、文档与 chart 实际状态不一致的地方,都能在一次评审中看清;
  • 生成结果与实际 chart 对齐,把文档更新变成发布前的一道检查关卡,而不是发完再补的收尾动作。

适用边界与注意点

  • 前提是本机已有 helm-docs CLI,技能本身不负责安装;
  • 用 docker 方式运行时要留意挂载路径与用户 uid 是否匹配,否则产物的属主会出问题;
  • 上游对注释有要求:字段本身和它下面的叶节点都需要补描述注释,只写一层会导致部分描述缺失;
  • 它解决的是「文档与 values 不一致」,不会去校验 chart 的模板逻辑或 values 的语义正确性。

使用场景

  • 每次发版前重新生成 chart 的 README,核对参数表与 values.yaml 是否完全一致
  • 在 values.yaml 里新增或删除配置项后,同步更新 README 说明,避免文档过期
  • 提交前 review diff,想看清文档改了哪些表格、哪些描述字段缺失
  • chart 由多人协作维护,发布到仓库前要做一遍文档与代码的对齐检查

适合人员

  • Helm chart 维护者:每次发版前要确认 README 与 values.yaml 没有漂移
  • 平台工程师:负责团队内部 chart 的迭代,希望文档随代码一起被评审
  • 开源 chart 作者:接受外部贡献,参数表靠手工维护容易漏改