关于 generate-release-notes
用于根据项目跟踪器或手动提供的变更编写发布说明的 Skill。它按类别整理内容并保存草稿,发布前必须获得批准。
主要功能
- 01从已启用的跟踪器收集工作
- 02接受手动提供的变更
- 03按发布类别整理更新
- 04将说明保存到项目库
- 05发布前要求批准
适用场景
- 01记录已完成的版本或里程碑
- 02总结冲刺结束时的工作
- 03根据跟踪器数据准备发布说明
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ huytieu/ cog-second-brain --skill generate-release-notes安装后在 Claude Code 中输入/generate-release-notes确认已加载。
详细介绍
COG 生成发行说明技能
调用时机
- 用户想要为某个版本、冲刺或周期创建发行说明
- 用户提到“发行说明”“变更日志”“发布了什么”“撰写发行说明”
- 新版本或里程碑已完成
- 冲刺/周期结束时的文档整理
Agent 模式说明
检查 00-inbox/MY-PROFILE.md 前置内容中的 agent_mode:
- 如果是
agent_mode: team,使用并行 Agent 同时从所有活跃来源收集数据 - 如果是
agent_mode: solo,按顺序从主要跟踪器收集数据
命令:/generate-release-notes
准备检查
-
读取
00-inbox/MY-INTEGRATIONS.md,确定数据来源和发布选项 -
读取
00-inbox/MY-PROFILE.md,了解活跃项目 -
获取当前时间戳: 使用 Bash 运行
date '+%Y-%m-%d %H:%M' -
询问用户(如果尚未提供):
- 这是哪个版本/发行版/周期的说明?
- 日期范围是什么?(或者:哪个里程碑/周期/冲刺?)
- 是哪个项目?(如果有多个活跃项目)
- 受众:内部团队、客户,还是两者?
执行策略
阶段 1:收集发行数据
团队模式(并行 Agent)
使用 Task 工具启动数据收集 Agent,并设置 run_in_background: true:
Agent:“github-release-collector”(如果 GitHub 已启用)
Collect all merged PRs and release data for the specified version/period.
Repository: [CUSTOMIZE: your-org/your-repo]
Period: [START_DATE] to [END_DATE]
1. Get merged PRs in the period:
gh pr list --repo [CUSTOMIZE: your-org/your-repo] --state merged --search "merged:[START_DATE]..[END_DATE]" --json number,title,author,labels,body,mergedAt --limit 200
2. Check for existing GitHub release (if version tag exists):
gh release view [VERSION_TAG] --repo [CUSTOMIZE: your-org/your-repo] --json name,body,tagName,createdAt 2>/dev/null
3. Get commits between tags (if applicable):
gh api repos/[CUSTOMIZE: your-org/your-repo]/compare/[PREV_TAG]...[CURRENT_TAG] --jq '.commits[] | {sha: .sha[:7], message: .commit.message, author: .author.login}'
Categorize each PR by its labels or title prefix:
- "feat"/"feature"/"enhancement" labels → Enhancements
- "fix"/"bug"/"bugfix" labels → Bug Fixes
- "tech"/"refactor"/"chore"/"infrastructure" labels → Technical Improvements
- "docs"/"documentation" labels → Documentation
- "security" labels → Security
- "breaking"/"breaking-change" labels → Breaking Changes
- "deprecation" labels → Deprecations
Return: categorized list of changes with PR numbers, titles, authors, and descriptions
Agent:“linear-release-collector”(如果 Linear 已启用)
Collect completed issues for the specified cycle/period.
1. Use ToolSearch to load Linear tools
2. List cycles: mcp__claude_ai_Linear_2__list_cycles
3. Find the target cycle or filter by date range
4. List all completed issues in the cycle/period: mcp__claude_ai_Linear_2__list_issues
5. For each issue, get details including labels and project
Categorize by label or issue type:
- Feature/Enhancement labels → Enhancements
- Bug labels → Bug Fixes
- Technical/Infrastructure labels → Technical Improvements
- Documentation labels → Documentation
Return: categorized list of changes with issue IDs, titles, assignees, and descriptions
Agent:“jira-release-collector”(如果 Jira 已启用)
Collect issues for the specified version/sprint.
Project: [CUSTOMIZE: YOUR-PROJECT-KEY]
1. Search by fixVersion:
JQL: project = "[CUSTOMIZE: YOUR-PROJECT-KEY]" AND fixVersion = "[VERSION]" AND status = Done ORDER BY issuetype, priority DESC
OR search by sprint:
JQL: project = "[CUSTOMIZE: YOUR-PROJECT-KEY]" AND sprint = "[SPRINT_NAME]" AND status = Done ORDER BY issuetype, priority DESC
2. For each issue, collect: key, summary, issuetype, priority, assignee, labels, description
Categorize by issue type:
- Story/Feature → Enhancements
- Bug → Bug Fixes
- Task/Technical Task → Technical Improvements
- Documentation → Documentation
Return: categorized list with issue keys, titles, assignees, types, and descriptions
单人模式
按顺序运行主要跟踪器的数据收集。
手动输入备用方案
如果没有启用跟踪器,或者用户更倾向于手动输入:
No project tracker detected. You can provide release items manually.
Please list the changes in this release. I'll categorize them for you.
Format: one change per line, optionally prefix with [feature], [fix], [tech], [docs], [security], [breaking]
阶段 2:分类和整理
将收集到的事项归入以下标准类别:
- 重大变更(如有,始终排在最前面)
- 新功能与增强
- 错误修复
- 技术改进
- 安全更新
- 文档
- 弃用项
- 已知问题(如仍有)
每个类别内按以下顺序排列:
- 优先级(从高到低)
- 用户影响(从影响最大到最小)
阶段 3:生成发行说明
面向客户/外部受众:
---
type: release-notes
project: [project-name]
version: [version]
date: [YYYY-MM-DD]
created: [YYYY-MM-DD HH:MM]
audience: external
tags: ["#release-notes", "#[project-name]", "#v[version]"]
items_count: [total count]
categories:
enhancements: [count]
bug_fixes: [count]
technical: [count]
security: [count]
breaking_changes: [count]
---
# Release Notes — [Project Name] [Version]
**Release Date:** [Date]
## What's New
[2-3 sentence executive summary of the most important changes in this release]
---
### Breaking Changes
> **Action Required:** The following changes may require updates to your workflow.
- **[Change title]** — [User-friendly description of what changed and what to do]
---
### New Features & Enhancements
- **[Feature title]** — [User-friendly description focused on the benefit to users]
- **[Feature title]** — [User-friendly description]
### Bug Fixes
- **[Fix title]** — [What was broken and how it's fixed, in user terms]
- **[Fix title]** — [Description]
### Security Updates
- **[Update title]** — [Description without exposing vulnerability details]
### Deprecations
- **[Deprecated feature]** — [What's being deprecated, timeline, and migration path]
---
### Known Issues
- [Known issue description] — [Workaround if available]
---
*For questions or feedback, [CUSTOMIZE: contact info or link]*
面向内部/团队受众:
---
type: release-notes
project: [project-name]
version: [version]
date: [YYYY-MM-DD]
created: [YYYY-MM-DD HH:MM]
audience: internal
tags: ["#release-notes", "#[project-name]", "#v[version]"]
source_tracker: [github/linear/jira/manual]
---
# Release Notes — [Project Name] [Version] (Internal)
**Release Date:** [Date]
**Cycle/Sprint:** [Name if applicable]
## Summary
[Executive summary with key stats: N features, N fixes, N tech improvements]
---
### Breaking Changes
- **[Title]** ([PR/Issue #link]) — [Technical description] — @[author]
### New Features & Enhancements
- **[Title]** ([PR/Issue #link]) — [Description] — @[author]
### Bug Fixes
- **[Title]** ([PR/Issue #link]) — [Description] — @[author]
### Technical Improvements
- **[Title]** ([PR/Issue #link]) — [Description] — @[author]
### Documentation
- **[Title]** ([PR/Issue #link]) — [Description] — @[author]
---
### Stats
- **Total items:** [N]
- **Contributors:** [list of contributors]
- **PRs merged:** [N]
- **Issues resolved:** [N]
---
### Known Issues & Follow-ups
- [ ] [Issue description] — Owner: [name]
阶段 4:审核关卡
向用户展示生成的发行说明:
Release notes draft is ready for [Project] [Version].
Summary:
- [N] New Features & Enhancements
- [N] Bug Fixes
- [N] Technical Improvements
- [N] other items
Audience: [external/internal]
Would you like to:
a) Review the full release notes
b) Save as-is to the vault
c) Make changes
d) Publish to [active platform] (requires your approval)
绝不要自动发布。始终等待用户明确批准。
阶段 5:保存到知识库
保存至:04-projects/[project]/release-notes/release-[version]-YYYY-MM-DD.md
mkdir -p "04-projects/[project]/release-notes"
阶段 6:发布(可选,需经批准)
仅在用户明确批准后继续。
GitHub 发行版
gh release create [VERSION_TAG] \
--repo [CUSTOMIZE: your-org/your-repo] \
--title "[Project] [Version]" \
--notes-file [path-to-release-notes]
Confluence
Use WebFetch to publish via Confluence REST API:
- Space: [CUSTOMIZE: YOUR-SPACE-KEY]
- Parent page: [CUSTOMIZE: Release-Notes-parent-page-id]
- Title: "Release Notes — [Project] [Version]"
Notion
1. Use ToolSearch to load Notion tools
2. Use mcp__claude_ai_Notion__notion-create-pages
HackMD
Use WebFetch to publish via HackMD API
发布后,使用已发布的 URL 更新知识库副本。
备用行为
| 场景 | 行为 |
|---|---|
| 未启用跟踪器 | 接受手动输入,或扫描日期范围内的 git 日志提交 |
| 跟踪器 API 失败 | 退回到 git 日志分析:git log --oneline [PREV_TAG]..[CURRENT_TAG] |
| 未指定版本标签 | 改用日期范围,或列出近期已完成的工作 |
| 来源混杂 | 合并多个跟踪器中的事项并去重 |
| 没有发布平台 | 仅保存到知识库 |
| 发行内容过多 | 拆分为“要点”部分和完整变更日志 |
错误处理
- 事项过多:如果超过 100 项,自动概述次要变更,仅详细列出重要事项
- 缺少 PR 描述:使用 PR 标题和提交消息作为备用
- 不同跟踪器中存在重复事项:根据标题/描述匹配并去重
- 上下文溢出:对数据收集进行分页,并按批次概述
评论
支持 Markdown