SuperAPI AI 工具集

prowler-changelog

通用与其它

查看项目

更新于 10-16 04:34

技能介绍

用途:按 keepachangelog.com 格式管理 Prowler 各组件(UI、API、MCP Server、SDK)的变更日志条目。PR 不直接编辑 CHANGELOG.md 的未发布内容,而是在对应组件的 changelog.d/ 目录下新建 fragment 文件,发布时由编译工作流汇总进各组件 CHANGELOG.md 并删除已消费的 fragment,从而减少并发 PR 冲突。目录对应:UI 为 ui/changelog.d/ 与 ui/CHANGELOG.md,API 为 api/changelog.d/ 与 api/CHANGELOG.md,MCP Server 为 mcp_server/changelog.d/ 与 mcp_server/CHANGELOG.md,SDK 为 prowler/changelog.d/ 与 prowler/CHANGELOG.md。

主要能力:fragment 文件名为 <slug>.<type>.md;type 映射固定小节:added、changed、deprecated、removed、fixed、security。内容只写条目文本,单行并以换行结尾;不要手写 PR 链接(编译时自动附加)、末尾不加句号、不以冗余动词开头、要具体。每个受影响组件至少一个 fragment,同一类型多条使用不同 slug。可用 no-changelog 标签跳过 PR 检查。遵循语义化版本:补丁、新功能、破坏性变更分别对应 PATCH、MINOR、MAJOR,removed 类型只能在 MAJOR 发布。

使用方式:用 git diff 判断受影响组件,创建 fragment,例如 echo 'Entry text describing the change' > <component>/changelog.d/<slug>.<type>.md;可用 ls 检查待处理 fragment。PR 检查工作流会校验 fragment 存在性、文件名与内容。发布时由编译工作流解析 PR、生成版本块 PR 并合并,补丁发布还包括向 master 的前向同步。

限制:创建或编辑 fragment 或 CHANGELOG.md 前必须获得用户明确确认;已发布条目仅拼写/更正可直改并加 no-changelog;条目按 PR 号升序排列;不删除发布起始标记。其余细节暂未提供。