更新日志生成器

技能文档

---
name: changelog-auto-gen
description: 通过分析git提交历史，自动分类变更并生成面向用户的更新日志（Changelog）。将技术提交转化为清晰的发布说明，支持多种格式输出。
title: 更新日志生成器
category: 开发工具
---

# 更新日志生成器

通过分析 git 提交历史，自动分类变更并生成面向用户的更新日志。将技术提交转化为清晰的发布说明，从数小时的手动编写缩短为几分钟自动完成。

## 触发条件

当用户提到以下内容时触发：
- 更新日志、changelog、发布说明
- 版本更新记录、变更日志
- 发布笔记、release notes
- 整理提交记录、版本变更

## 工作流程

### 第一步：获取提交历史

```bash
# 获取自上一个版本以来的提交
git log v1.0.0..HEAD --pretty=format:"%h|%s|%an|%ad" --date=short

# 获取最近N天的提交
git log --since="7 days ago" --pretty=format:"%h|%s|%an|%ad" --date=short

# 获取指定范围的提交
git log abc123..def456 --pretty=format:"%h|%s|%an|%ad" --date=short
```

### 第二步：提交分类

将提交按以下类别自动分类：

| 类别 | 图标 | 识别规则 |
|------|------|---------|
| 新功能 | ✨ | feat:、add:、新增、功能 |
| 修复 | 🐛 | fix:、修复、bug、patch |
| 性能优化 | ⚡ | perf:、优化、improve、speed |
| 重构 | ♻️ | refactor:、重构、cleanup |
| 文档 | 📝 | docs:、文档、readme |
| 样式 | 💄 | style:、UI、样式、css |
| 测试 | ✅ | test:、测试、spec |
| 构建 | 📦 | build:、chore:、依赖、build |
| 废弃 | ⚠️ | deprecate:、废弃、deprecated |
| 安全 | 🔒 | security:、安全、CVE |
| 破坏性变更 | 🔥 | BREAKING CHANGE、!: |

### 第三步：内容转化

将技术性提交信息转化为面向用户的描述：

| 技术提交 | 用户友好描述 |
|---------|------------|
| feat(auth): add OAuth2 login | 新增 OAuth2 第三方登录支持 |
| fix(api): resolve null pointer in user endpoint | 修复用户接口偶发异常问题 |
| perf(db): optimize query with index | 优化数据库查询性能，响应速度提升约40% |
| refactor(ui): simplify component structure | 优化界面组件结构，提升页面加载速度 |

#### 转化规则

1. **去除技术术语**：将"null pointer"转为"异常问题"
2. **量化改进**：尽可能给出具体提升数据
3. **用户视角**：从用户能感知的角度描述变更
4. **合并相关提交**：多个相关提交合并为一条说明
5. **去除无意义提交**：跳过 merge commit、typo fix 等

### 第四步：生成日志

#### 4.1 标准格式（Keep a Changelog）

```markdown
# Changelog

所有重要的变更都记录在此文件中。

格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/)，
版本遵循 [语义化版本](https://semver.org/lang/zh-CN/)。

## [1.2.0] - 2024-03-15

### 新增
- 支持 OAuth2 第三方登录（GitHub、Google）
- 新增数据导出功能，支持 CSV 和 Excel 格式
- 添加暗色主题切换

### 修复
- 修复用户头像上传偶发失败的问题
- 解决移动端页面滚动卡顿
- 修正时区转换导致的日期显示错误

### 优化
- 数据库查询性能提升约 40%
- 首屏加载时间从 3.2s 降至 1.8s

### 变更
- 升级 React 至 18.3
- 更新 API 响应格式（向下兼容）

### 废弃
- 旧版 API v1 接口将于下版本移除，请迁移至 v2

## [1.1.0] - 2024-02-20
...
```

#### 4.2 简洁格式

```markdown
# v1.2.0 (2024-03-15)

✨ 新功能：OAuth2登录、数据导出、暗色主题
🐛 修复：头像上传、滚动卡顿、时区问题
⚡ 优化：查询性能+40%、首屏加载-44%
```

#### 4.3 详细格式（含提交引用）

在标准格式基础上，每条变更附上相关提交哈希链接。

### 第五步：输出

支持以下输出格式：
1. **Markdown**：标准 CHANGELOG.md 文件
2. **JSON**：结构化数据，供 CI/CD 使用
3. **纯文本**：用于发布说明
4. **HTML**：用于邮件通知

## 配置选项

```yaml
# changelog 配置
changelog:
  # 上一个版本标签
  previous_tag: "v1.1.0"
  # 当前版本
  version: "1.2.0"
  # 发布日期
  date: "2024-03-15"
  # 输出格式
  format: "markdown"  # markdown | json | text | html
  # 是否包含提交链接
  include_links: true
  # 仓库地址
  repo_url: "https://github.com/user/repo"
  # 自定义分类
  categories:
    - type: "feat"
      label: "新增"
      icon: "✨"
    - type: "fix"
      label: "修复"
      icon: "🐛"
  # 排除的提交
  exclude:
    - "merge"
    - "typo"
    - "WIP"
```

## 注意事项

1. **提交规范**：建议使用 Conventional Commits 规范
2. **人工审核**：生成后建议人工审核确认
3. **增量更新**：支持在已有 CHANGELOG.md 中插入新版本
4. **多语言**：支持中英文提交信息的识别和输出
5. **版本对比**：自动生成版本间的对比链接

如何安装此技能？

访问技能市场，点击「安装」按钮，按提示将技能包放入 AI 编程助手的 skills 目录即可。