SuperAPI AI 工具集

changelog

编程与开发

查看项目

更新于 10-16 04:24

技能介绍

用途

该技能用于为代码仓库主分支最近的合并生成生动、有趣的变更日志,面向内部开发团队。它以“机智且热情的产品营销人员”的口吻,总结最新合并内容,突出新功能、缺陷修复,并向辛勤工作的开发者致谢。

主要能力

  • 按时间范围汇总:日报查看最近 24 小时内合并的 PR;周报查看最近 7 天内合并的 PR。标题中需注明时间周期(如“Daily”或“Weekly”)。默认获取仓库主分支最近一天的变更。
  • PR 分析:分析提供的 GitHub 变更及相关 issue,识别新增功能、已实现的缺陷修复、其他重要改动或改进、具体 issue 及其详情、贡献者姓名。使用 gh CLI 查询 PR 及其描述,检查 PR 标签以识别变更类型(feature、bug、chore 等),查找并突出破坏性变更,包含 PR 编号以便追溯,检查 PR 是否关联 issue 并纳入 issue 上下文。
  • 内容优先级:破坏性变更(如有)必须置于顶部,其次是面向用户的功能、关键缺陷修复、性能改进、开发者体验改进、文档更新。
  • 格式规范:简洁切题,最重要的变更优先,相似变更分组(如所有新功能、所有缺陷修复),包含 issue 引用,提及贡献者姓名并致谢,加入幽默或俏皮感,少量使用 emoji,Discord 消息总长控制在 2000 字符以内,每个部分使用一致的 emoji,代码/技术术语用反引号,PR 编号放在括号中(如“Fixed login bug (#123)”)。
  • 部署说明:在相关时包含数据库迁移、环境变量更新、部署后手动干预步骤、需要更新的依赖。
  • 输出结构:最终输出格式为 <change_log> 标签包裹,包含标题(🚀 [Daily/Weekly] Change Log: [当前日期])、破坏性变更(🚨)、新功能(🌟)、缺陷修复(🐛)、其他改进(🛠️)、致谢(🙌)、每日趣味事实(🎉)。
  • 样式指南审查:使用 EVERY_WRITE_STYLE.md 文件逐项检查变更日志是否符合样式指南,可使用多个 agent 并行运行以加快速度。最终输出只包含 <change_log> 标签内的内容,不包含思考过程或原始数据。
  • Discord 发布(可选):通过添加自己的 Webhook URL 将变更日志发布到 Discord。设置 DISCORD_WEBHOOK_URL 环境变量,使用 curl 发送 JSON 内容。获取 Webhook URL 的路径:Discord 服务器 → 服务器设置 → 集成 → Webhooks → 新建 Webhook。
  • 错误处理:若时间段内无变更,发布“安静日”消息:“🌤️ Quiet day! No new changes merged.”;若无法获取 PR 详情,列出 PR 编号供人工审查;发布到 Discord 前始终校验消息长度(最多 2000 字符)。
  • 调度建议:每日纽约时间早上 6 点运行,处理前一天的变更;每周一运行周报,汇总上一周;重大发布或部署后可进行特别运行。
  • 受众考量:根据频道调整语气和详细程度。开发团队频道包含技术细节、性能指标、代码片段;产品团队频道聚焦面向用户的变更和业务影响;领导层频道突出关键举措进展和阻塞项。

使用方式

该技能以提示词形式定义,使用时需提供 GitHub 变更数据,并借助 gh CLI 查询 PR 信息。最终输出为 <change_log> 标签包裹的文本。可选配置 Discord Webhook 进行发布。

适用场景

适用于内部开发团队需要定期生成变更日志的场景,如每日站会、周报汇总、重大发布后的通报,以及向不同受众(开发、产品、领导层)同步进展。

限制

  • 消息长度受 Discord 限制,需控制在 2000 字符以内。
  • 依赖 gh CLI 获取 PR 详情,若无法获取则需人工审查。
  • 样式指南审查依赖 EVERY_WRITE_STYLE.md 文件。
  • 其他具体限制暂未提供。