Communitygithub.com

版本发布说明

从 Git 历史记录生成精美的版本发布说明。在发布版本前、发布 GitHub Release 时,或需要根据两个标签之间的提交生成变更日志时使用。按类型分组变更,突出破坏性变更,并草拟重点内容。

版本发布说明 是什么?

该技能能够将原始的 Git 提交历史转化为清晰易读的版本发布说明(Release Notes),专为开发者在使用 Git 标签发布版本时设计。它支持 Claude Code、Cursor、Codex 等 AI 编程助手,通过解析符合常规提交规范(Conventional Commits)的提交记录,自动将变更分类为功能特性、Bug 修复、破坏性变更等类别。技能的优势在于不仅分门别类整理变更,还能智能检测破坏性变更标记(如 `!` 或 `BREAKING CHANGE:` 脚注),并从众多提交中自动提炼出 3-5 条对用户最重要的重点变更(Highlights)。工作流程包括:收集两个 Git 引用(标签、分支或 HEAD)之间的提交历史、根据提交前缀分类、起草重点、生成符合 GitHub Release 格式的 Markdown 文本,并在发布前进行完整性校验。这使得非专业的发布经理也能快速生成专业、完整的版本说明,避免遗漏重要变更或包含内部琐事。

兼容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/unisone/openclaw-skill-suite/tree/main/skills/release-notes

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

版本发布说明 是做什么的?

将原始的 Git 历史记录转化为人类真正愿意阅读的发布说明。

功能

  • 比较两个 Git 引用(标签、分支或 HEAD)之间的提交差异
  • 按类型对变更进行分组:功能特性、Bug 修复、破坏性变更、杂项
  • 从常规提交的 ! 标记和 BREAKING CHANGE: 脚注中检测破坏性变更
  • 草拟重点变更部分(用户最关心的 3-5 个变更)
  • 输出可直接用于 GitHub Release 的 Markdown 格式

使用方法

# 为即将发布的版本生成说明(上一个标签到 HEAD)
git log $(git describe --tags --abbrev=0)..HEAD --oneline

# 在两个标签之间生成
git log v1.2.0..v1.3.0 --pretty=format:'%h %s %b'

然后对 AI 助手说:“根据这些提交为 v1.3.0 起草版本发布说明。”

或者配合 GitHub CLI,直接进入发布草稿:

# 创建标签,然后根据差异生成发布说明草稿
git tag v1.3.0 && git push origin v1.3.0
gh release create v1.3.0 --generate-notes --draft
# 然后使用此技能完善生成的说明

处理流程

1. 收集提交

git log <上一个标签>..<新标签> --pretty=format:'%h|%s|%b|%an' --no-merges

如果仓库使用基于合并的工作流,应单独包含合并提交——合并标题通常比单个提交的信息更能概括 PR 的内容。

2. 对每个提交进行分类

前缀 / 信号所属章节
feat、feat!功能特性
fixBug 修复
! 或 BREAKING CHANGE:⚠️ 破坏性变更(也会列在独立章节中)
perf性能优化
docs、chore、ci、refactor、test归入“其他变更”或忽略

没有常规提交前缀的提交:根据消息内容进行分类。如果拿不准,宁可放在“其他变更”中,也不要静默丢弃。

3. 起草重点变更

挑选出对软件用户最关键的 3-5 个变更:

  • 用户会注意到的全新功能
  • 用户必须采取行动的破坏性变更
  • 针对广泛报告问题的修复

每项用一句简单的话描述。避免使用营销形容词。

4. 编写发布说明

## v1.3.0

**重点变更**
- ...
- ...

### ⚠️ 破坏性变更
- ...

### 功能特性
- ...

### Bug 修复
- ...

### 其他变更
- ...

**完整变更日志:** <上一个标签>...<新标签>

5. 发布前的检查清单

  • 每个破坏性变更都出现在 ⚠️ 章节中,并附有迁移提示
  • 没有将仅供内部使用的杂项内容伪装成面向用户的功能特性
  • 按照仓库惯例,对贡献者进行致谢
  • 版本号与标签匹配

约定

  • 如果仓库已有自己的版本发布说明风格,请遵循该风格——一致性胜过任何模板。
  • 如果仓库使用 gh release --generate-notes,将其输出作为起始草稿并进行完善:它能正确列出变更列表,但重点部分通常不准确。
  • 绝不发明提交范围中不存在的变更。当范围不明确时,应询问要比较哪两个引用,而不是猜测。

Individual skills in this repo

This repo contains 10 individual skills — each has its own dedicated page.

astra-operator

Delegate computer-use and browser tasks to OpenAI

design-inspo

Find design inspiration from curated gallery sites. Use when a user needs UI/UX references, design examples, or inspiration for specific components (navbars, CTAs, hero sections, landing pages, etc.), full websites, SaaS products, mobile apps, animations, icons, branding, or design systems. Helps select the right inspiration source and browse examples.

graphrag

Build a GraphRAG pipeline over documents. Use when plain vector search returns chunks without connections, when questions need multi-hop reasoning (

mundane-demos

Demo strategy that leads with mundane real-life utility instead of benchmarks. Use when presenting an AI agent or product to non-technical audiences. Covers picking tasks the viewer did this morning, showing end-to-end completion, and letting speed be the wow factor.

remotion-product-demos

Create Apple-keynote-quality product demo videos with Remotion. Covers glass phone mockups, floating 3D spheres, typing animations, card UIs, ripple effects, and smooth scene transitions. Use when asked to create product demos, app showcase videos, UI walkthrough animations, or

repo-security-scan

Scan a repository for high-signal security issues and produce a report. Use when auditing a codebase for leaked secrets or vulnerable dependencies, before a release, or when onboarding an unfamiliar repo. Runs gitleaks secret scanning and osv-scanner dependency checks.

secure-agent-design

Security architecture patterns for personal AI agents that touch real accounts. Use when designing an agent with access to inbox, calendar, finances, or shopping. Covers per-user isolated VMs, pre-action sentinel checks, least-privilege connectors, human approval gates, and single-use payment credentials.

testimonial-launch

Turn user testimonials into launch distribution. Use when launching a product or feature and you want real user proof to carry the announcement instead of marketing copy. Covers soliciting specific testimonials, curating them, and amplifying via quote-posts.

unisone/openclaw-skill-suite

Create Apple-keynote-quality product demo videos with Remotion. Covers glass phone mockups, floating 3D spheres, typing animations, card UIs, ripple effects, and smooth scene transitions. Use when asked to create product demos, app showcase videos, UI walkthrough animations, or

validator-quotes

Earn and deploy third-party validator quotes for a launch. Use when you need credibility beyond your own claims. Covers who to approach, how to get honest reactions, and how to amplify them via quote-posts, based on the founder/CEO validators behind the Muse launch.

相关技能