changelog-automation

概览

什么是 changelog-automation？

changelog-automation 是一款工作流自动化技能，旨在根据您的 Git 提交历史、拉取请求和发布自动生成更新日志、发布说明并管理版本。它遵循 Keep a Changelog 格式，支持语义化版本控制，方便您在项目中统一发布文档标准。

谁适合使用此技能？

• 希望自动生成发布说明的开发团队
• 规范提交和发布流程的开源维护者
• 采用 Conventional Commits 或语义化版本控制的项目
• 想减少手动维护更新日志的任何人

解决的问题

• 消除手动更新日志的繁琐
• 确保发布说明的一致性
• 与 GitHub/GitLab 工作流集成
• 强制执行提交信息规范

使用方法

安装步骤

1. 通过以下命令将技能添加到您的 agent：

   npx skills add https://github.com/wshobson/agents --skill changelog-automation

2. 查阅 SKILL.md 主文档，了解设置细节和最佳实践。

3. 浏览 README.md、AGENTS.md 和 metadata.json 等辅助文件，获取更多背景信息。

4. 将技能集成到您的仓库工作流中，根据您的 CI/CD 流程和团队规范调整示例模式。

关键概念

• Keep a Changelog 格式： 技能生成标准化格式的更新日志，便于跟踪变更和发布。
• Conventional Commits： 提交信息需遵循 Conventional Commits 规范，以支持准确的日志生成和语义化版本控制。
• 发布自动化： 支持为 GitHub/GitLab 生成发布说明并自动管理版本号。

示例工作流

• 开发者使用 Conventional Commits 编写提交信息。
• 发布时，changelog-automation 解析提交历史，生成或更新 CHANGELOG.md 文件。
• 自动发布发布说明，并根据语义化版本规则管理版本号。

常见问题

什么时候适合使用 changelog-automation？

如果您想自动生成更新日志和发布说明，强制执行提交规范，或简化发布流程，changelog-automation 是理想选择。特别适合采用语义化版本和 Conventional Commits 的团队。

我应该先查看哪些文件？

建议先阅读 SKILL.md，了解概览和安装说明。然后查看 README.md 和 metadata.json，获取更多集成细节。

changelog-automation 支持自定义工作流吗？

支持，您可以根据仓库结构和 CI/CD 工具调整技能的模式。请查阅仓库中的辅助脚本和文档，了解定制选项。

它如何处理版本管理？

技能根据提交信息判断版本升级，遵循语义化版本控制，确保发布一致且可预测。

哪里可以找到更多详情？

请浏览仓库的 Files 标签，查看所有文档、脚本和参考资料，支持高级用法和故障排查。