SuperAPI AI 工具集

docs-updater

写作与研究

查看项目

更新于 10-15 21:52

技能介绍

用途:根据 git 历史自动更新项目文档。它对比当前分支与最近发布标签,识别与发布相关的变更,然后更新 README.md、CHANGELOG.md 及相关文档目录。

主要能力:检测最近发布标签并确定版本号;执行 git diff 分析提交数量、文件变更统计与提交信息;发现 docs、documentation、doc 及插件级文档目录;按 Keep a Changelog 规范生成 Added、Changed、Fixed、Removed、Security 等分类条目;更新 README 的功能列表、安装说明与版本引用;将变更映射到对应文档文件。

使用方式:先确认处于 git 仓库且存在至少一个发布标签,并检查 README.md、CHANGELOG.md 是否存在。技能依次执行检测版本、diff 分析、发现文档结构、生成 CHANGELOG、更新 README、更新文档目录、展示待改内容供确认、应用更新并验证。常用命令包括 git describe --tags --abbrev=0、git diff --stat ${LATEST_TAG}..HEAD、git log ${LATEST_TAG}..HEAD --pretty=format:"%h|%s|%b" --reverse、git diff --name-status ${LATEST_TAG}..HEAD。

适用场景:准备发布说明或 Unreleased 变更日志;功能开发完成后同步 README 或文档;在 PR 或发布前审查自上次发布以来的变更。

限制:必须有至少一个发布标签,否则无法比较;分析为只读,写入前需用户确认;生成的条目需人工复核;对使用约定式提交的项目效果最佳;不创建发布标签,不自动提交;部分项目可能有自定义变更日志格式需遵循。