Semantic Release 发布说明生成器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/generate-conventional-commit-release-notes-for-automated-ship-workflows-with-semantic-release-release-notes-generator。
技能介绍
要解决的问题
在自动化发布流水线里,发布说明的编写常陷入两难:手动整理耗时且易与代码变更脱节,自动生成又常出现格式混乱、遗漏关键变更的情况,导致维护者难以快速厘清版本差异。
核心能力与工作方式
该技能聚焦从常规提交(Conventional Commits)生成结构化发布说明这一具体任务,核心是依赖 semantic-release 生态中的 release-notes-generator 能力:
- 自动解析提交信息中的类型(如
feat、fix)、范围(如api、ui)和描述内容 - 按规则对变更进行分类和排序,生成包含新增功能、问题修复等模块的发布说明
- 适配自动化发布流程,无需人工干预即可输出格式统一的说明文档
适用边界与注意点
- 仅适用于已采用常规提交规范的项目,非规范格式的提交不会被正确解析
- 是发布流水线的一环,需配合
semantic-release的核心流程使用 - 若项目未直接依赖该包但已使用
semantic-release,无需额外安装即可启用基础能力
使用场景
- 持续集成流水线触发版本发布,需要自动生成结构化发布说明
- 仓库采用常规提交规范,需将多次提交按类型整理为变更日志
- 发布新版本时需汇总功能新增与问题修复,形成面向用户的版本说明
- 维护开源项目,需将代码提交记录转化为标准格式的发布说明文档
适合人员
- DevOps 工程师:需要在自动化流水线中配置发布说明生成环节
- 开源项目维护者:希望将代码提交记录自动转化为规范的发布说明
- 后端开发者:项目采用常规提交规范,需自动生成版本变更文档
- 前端团队负责人:需在每次发布时获得结构清晰的功能与修复清单