关于 changelog
此仓库技能说明 release-please 如何根据 Conventional Commits 生成并发布 CHANGELOG.md,供维护者了解条目规则、Release PR 流程及缺失记录的排查方法。
主要功能
- 01按提交类型映射变更日志章节
- 02说明 release-please 生成步骤
- 03列出查看发布说明的命令
- 04记录缺失条目的排查方法
适用场景
- 01检查提交未出现在变更日志的原因
- 02预览待处理 Release PR 中的说明
- 03查找已发布的 GitHub Release 说明
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ motormetrics/ motormetrics --skill changelog安装后在 Claude Code 中输入/changelog确认已加载。
详细介绍
更新日志技能
每次发布 PR 的一部分,CHANGELOG.md 都由 release-please 生成。
工作原理
- release-please 在推送到
main时运行 - 它根据上次发布以来的约定式提交生成说明
- 说明会添加到未合并的发布 PR 中的
CHANGELOG.md开头 - 合并发布 PR 后,会提交更新日志,并将相同的说明发布为 GitHub Release
更新日志章节
提交类型与更新日志章节的对应关系:
| 提交类型 | 更新日志章节 |
|---|---|
feat | 新功能 |
fix | 错误修复 |
perf | 性能改进 |
revert | 撤销 |
feat! / BREAKING CHANGE | ⚠ 重大变更 |
类型 chore、docs、refactor、test、ci、build 和 style 不会出现在更新日志中。
查看更新日志
# View the changelog file
cat CHANGELOG.md
# View a specific GitHub release's notes
gh release view v5.31.0
# Preview the next entry in the open Release PR
gh pr list --label "autorelease: pending"
缺少更新日志条目?
- 检查提交类型:只有
feat、fix、perf和revert会生成条目 - 确认提交已合并到
main - 检查发布 PR 是否已更新:
gh run list --workflow=release.yml - 确保提交消息遵循约定格式
文件位置
- 更新日志:
CHANGELOG.md(仓库根目录) - 配置:
release-please-config.json
相关内容
- 有关发布工作流,请参阅
release-management技能
评论
支持 Markdown