update_changelog
Skill135 starsChanged 2 days agoApache-2.0View on GitHub
如何高效总结并更新项目的 CHANGELOG.md (How to update CHANGELOG.md)
In this repository17 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- clocSkill
- compare-layoutsSkill
- convert-to-digitalSkill
- fix-github-issueSkill
- prepare-next-versionSkill
- refactorSkill
- regression-testSkill
- release_processSkill
- save_conversationSkill
- startupSkill
- summarize-experienceSkill
- test-texSkill
- track-workSkill
- update_wikiSkill
- 数字化一致性检查Skill
The file
Files
更新 CHANGELOG.md 工作流
本工作流旨在指导如何快速总结项目阶段性改动并录入 CHANGELOG.md。
1. 提取改动记录 (Extract Changes)
- 运行命令:
git log v[上一个tag]..HEAD --oneline(例如git log v0.1.4..HEAD --oneline)。 - 必须执行:列出所有带
fix-ready标签的 open issue —— 这些是已合并、待发版的修复:gh issue list --label fix-ready --state open(PR 合并时 issue 不会被关闭,而是由.github/workflows/fix-ready-label.yml加上fix-ready标签。) - 重点关注以下内容:
- 带
fix-ready标签的 issue,以及标题/正文带(#xxx)、Refs #xxx的提交。 - 带有
feat,added,refactor等功能性描述。
- 带
2. 编写更新条目 (Write Entries)
- CRITICAL - Issue 完整性:每个
fix-readyissue 都必须在 CHANGELOG 里有一条(fix #xxx),绝对不可遗漏。发版时 Release 说明取自 CHANGELOG,Release 发布后 workflow 会关闭说明里fix #xxx提到的 issue 并去掉fix-ready标签;漏写的 issue 会一直挂着。 - 简洁性:将同类改动合并,总量控制在 5-6 个条目以内。
- 纯文本:不要使用粗体(着重号),确保列表整洁。
- 关联 Issue:在条目末尾使用
(fix #xxx)标注对应的 Issue 编号。
3. 更新文件内容
- 在
CHANGELOG.md顶部插入新版本号和日期,格式为:## [版本号] - YYYY-MM-DD。 - 将总结好的条目以无序列表形式填入其下方。
4. 验证完整性 (Verification) - 必须执行
更新完成后,必须执行以下验证:
# 列出所有待发版的修复
gh issue list --label fix-ready --state open
# 检查 CHANGELOG 中是否包含所有 fix
grep "fix #" CHANGELOG.md | head -20逐一对比两个输出,确保每个 fix-ready issue 都有对应的 fix #xx 条目。如有遗漏,立即补充。
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

