自动化更新日志生成工具 - 基于Git历史智能生成专业更新日志和发布说明

changelog-writer by patricio0312rev/skills

278 周安装量

20 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/patricio0312rev/skills --skill changelog-writer

开发自动化技术文档

🇨🇳中文介绍

更新日志与发布说明撰写器

根据版本控制历史生成专业的更新日志和发布说明。

核心工作流程

分析提交记录 : 解析自上次发布以来的 git 历史
分类变更 : 按类型分组（功能、修复、文档等）
识别破坏性变更 : 标记不兼容的更改
提取亮点 : 突出最重要的变更
格式化文档 : 遵循 Keep a Changelog 格式
建议版本号 : 推荐语义化版本号变更
生成发布说明 : 创建用户友好的摘要

提交记录分析

从以下来源提取信息

提交信息（最好是约定式提交）
PR 标题和描述
问题引用（#123）
合并提交信息
提交作者

解析模式

feat(auth): add OAuth2 support
^    ^      ^
|    |      └─ 描述
|    └─ 范围（可选）
└─ 类型

类型到类别的映射:

feat → 新增
fix → 修复

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

相关 Skills

FlyClaw：零登录航班聚合查询工具，Python实现多源航班信息与价格搜索

4,000,000 周安装

find-skills 技能搜索工具 - Vercel Labs 开源智能体技能包管理器

776,000 周安装

Vercel React 最佳实践指南 | 58条Next.js性能优化规则与代码重构

261,300 周安装

Vercel Web界面规范检查工具 - 自动检测代码是否符合Web设计指南

210,800 周安装

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- New feature X
- Support for Y

### Changed

- Updated Z behavior

### Fixed

- Resolved issue #123

## [2.1.0] - 2024-01-15

### Added

- OAuth2 authentication support
- User profile management API
- Dark mode toggle

### Changed

- Improved error messages
- Updated dependencies to latest versions

### Deprecated

- Legacy authentication method (will be removed in 3.0.0)

### Fixed

- Memory leak in WebSocket connection
- Incorrect date formatting in reports
- Race condition in concurrent requests

### Security

- Patched XSS vulnerability in user input

## [2.0.0] - 2023-12-01

### Breaking Changes

- ⚠️ Removed support for Node.js 16
- ⚠️ Changed API response format for `/users` endpoint
- ⚠️ Renamed `config.yaml` to `config.yml`

### Added

- Complete API rewrite with improved performance
- WebSocket support for real-time updates

### Migration Guide

See [MIGRATION_v2.md](./docs/MIGRATION_v2.md) for upgrade instructions.

[unreleased]: https://github.com/user/project/compare/v2.1.0...HEAD
[2.1.0]: https://github.com/user/project/compare/v2.0.0...v2.1.0
[2.0.0]: https://github.com/user/project/releases/tag/v2.0.0

# Release v2.1.0 - "Feature Release Name"

Released: January 15, 2024

## 🎉 Highlights

This release brings major improvements to authentication and user experience:

- **OAuth2 Support**: Users can now sign in with Google, GitHub, and Microsoft
- **Dark Mode**: Toggle between light and dark themes
- **Performance**: 40% faster API response times

## ✨ New Features

- OAuth2 authentication with popular providers (#456)
- User profile management API (#478)
- Dark mode toggle in settings (#492)
- Export data in CSV format (#501)

## 🐛 Bug Fixes

- Fixed memory leak in WebSocket connections (#489)
- Resolved incorrect date formatting in reports (#495)
- Fixed race condition in concurrent API requests (#503)

## 🔄 Changes

- Improved error messages across the application
- Updated all dependencies to latest stable versions
- Refined UI animations for smoother experience

## 🔒 Security

- Patched XSS vulnerability in user input validation
- Updated JWT library to address CVE-2024-1234

## 📚 Documentation

- Added OAuth2 setup guide
- Updated API reference with new endpoints
- Improved troubleshooting section

## 🙏 Contributors

Thank you to all contributors who made this release possible:

- @alice - OAuth2 implementation
- @bob - Dark mode feature
- @charlie - Bug fixes and testing

## 📦 Installation

```bash
npm install project-name@2.1.0
# or
yarn add project-name@2.1.0
```

## 语义化版本规则

给定版本号 MAJOR.MINOR.PATCH（例如，2.1.0）：

1. **主版本号** (2.x.x → 3.x.x)
   - 破坏性变更
   - 不兼容的 API 更改
   - 移除的功能

2. **次版本号** (2.1.x → 2.2.x)
   - 新功能
   - 向后兼容的功能
   - 已弃用的功能

3. **修订号** (2.1.0 → 2.1.1)
   - 错误修复
   - 安全补丁
   - 性能改进

**特殊版本：**
- `0.x.x` - 初始开发（允许在次版本中进行破坏性变更）
- `x.y.0-alpha.1` - 预发布版本
- `x.y.0-beta.2` - Beta 版本
- `x.y.0-rc.1` - 候选发布版本

## 用于生成更新日志的 Git 命令

```bash
# 获取自上次标签以来的提交
git log $(git describe --tags --abbrev=0)..HEAD --oneline

# 获取两个标签之间的提交
git log v2.0.0..v2.1.0 --oneline

# 获取带有 PR 编号的提交
git log --merges --pretty=format:"%s" v2.0.0..HEAD

# 获取贡献者
git log v2.0.0..HEAD --format='%aN' | sort -u

# 按类型获取提交计数
git log v2.0.0..HEAD --oneline | grep -E '^[a-f0-9]+ (feat|fix|docs)' | cut -d' ' -f2 | sort | uniq -c

🇺🇸English

Changelog & Release Notes Writer

Generate professional changelogs and release notes from version control history.

Core Workflow

Analyze commits : Parse git history since last release
Categorize changes : Group by type (feat, fix, docs, etc.)
Identify breaking changes : Flag incompatible changes
Extract highlights : Surface most important changes
Format document : Follow Keep a Changelog format
Suggest version : Recommend semantic version bump
Generate release notes : Create user-friendly summary

Commit Analysis

Extract Information From

Commit messages (preferably conventional commits)
PR titles and descriptions
Issue references (#123)
Merge commit messages
Commit authors

Parse Patterns

feat(auth): add OAuth2 support
^    ^      ^
|    |      └─ Description
|    └─ Scope (optional)
└─ Type

Types to Categories:

feat → Added
fix → Fixed
docs → Documentation
style, refactor → Changed
perf → Performance
test → Testing
chore, ci → Internal
BREAKING CHANGE → Breaking Changes

Changelog Format (Keep a Changelog)

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- New feature X
- Support for Y

### Changed

- Updated Z behavior

### Fixed

- Resolved issue #123

## [2.1.0] - 2024-01-15

### Added

- OAuth2 authentication support
- User profile management API
- Dark mode toggle

### Changed

- Improved error messages
- Updated dependencies to latest versions

### Deprecated

- Legacy authentication method (will be removed in 3.0.0)

### Fixed

- Memory leak in WebSocket connection
- Incorrect date formatting in reports
- Race condition in concurrent requests

### Security

- Patched XSS vulnerability in user input

## [2.0.0] - 2023-12-01

### Breaking Changes

- ⚠️ Removed support for Node.js 16
- ⚠️ Changed API response format for `/users` endpoint
- ⚠️ Renamed `config.yaml` to `config.yml`

### Added

- Complete API rewrite with improved performance
- WebSocket support for real-time updates

### Migration Guide

See [MIGRATION_v2.md](./docs/MIGRATION_v2.md) for upgrade instructions.

[unreleased]: https://github.com/user/project/compare/v2.1.0...HEAD
[2.1.0]: https://github.com/user/project/compare/v2.0.0...v2.1.0
[2.0.0]: https://github.com/user/project/releases/tag/v2.0.0

Release Notes Format

# Release v2.1.0 - "Feature Release Name"

Released: January 15, 2024

## 🎉 Highlights

This release brings major improvements to authentication and user experience:

- **OAuth2 Support**: Users can now sign in with Google, GitHub, and Microsoft
- **Dark Mode**: Toggle between light and dark themes
- **Performance**: 40% faster API response times

## ✨ New Features

- OAuth2 authentication with popular providers (#456)
- User profile management API (#478)
- Dark mode toggle in settings (#492)
- Export data in CSV format (#501)

## 🐛 Bug Fixes

- Fixed memory leak in WebSocket connections (#489)
- Resolved incorrect date formatting in reports (#495)
- Fixed race condition in concurrent API requests (#503)

## 🔄 Changes

- Improved error messages across the application
- Updated all dependencies to latest stable versions
- Refined UI animations for smoother experience

## 🔒 Security

- Patched XSS vulnerability in user input validation
- Updated JWT library to address CVE-2024-1234

## 📚 Documentation

- Added OAuth2 setup guide
- Updated API reference with new endpoints
- Improved troubleshooting section

## 🙏 Contributors

Thank you to all contributors who made this release possible:

- @alice - OAuth2 implementation
- @bob - Dark mode feature
- @charlie - Bug fixes and testing

## 📦 Installation

```bash
npm install project-name@2.1.0
# or
yarn add project-name@2.1.0
```

🔗 Links

Note: This is a minor release. No breaking changes. Safe to upgrade from 2.0.x.

## Semantic Versioning Rules

Given a version number MAJOR.MINOR.PATCH (e.g., 2.1.0):

1. **MAJOR** (2.x.x → 3.x.x)
   - Breaking changes
   - Incompatible API changes
   - Removed features

2. **MINOR** (2.1.x → 2.2.x)
   - New features
   - Backward-compatible functionality
   - Deprecated features

3. **PATCH** (2.1.0 → 2.1.1)
   - Bug fixes
   - Security patches
   - Performance improvements

**Special versions:**
- `0.x.x` - Initial development (breaking changes allowed in minor)
- `x.y.0-alpha.1` - Pre-release
- `x.y.0-beta.2` - Beta release
- `x.y.0-rc.1` - Release candidate

## Git Commands for Changelog Generation

```bash
# Get commits since last tag
git log $(git describe --tags --abbrev=0)..HEAD --oneline

# Get commits between two tags
git log v2.0.0..v2.1.0 --oneline

# Get commits with PR numbers
git log --merges --pretty=format:"%s" v2.0.0..HEAD

# Get contributors
git log v2.0.0..HEAD --format='%aN' | sort -u

# Get commit count by type
git log v2.0.0..HEAD --oneline | grep -E '^[a-f0-9]+ (feat|fix|docs)' | cut -d' ' -f2 | sort | uniq -c

Breaking Changes Detection

Look for these indicators:

Commit message contains BREAKING CHANGE:
Commit type has ! (e.g., feat!:)
PR labeled with "breaking-change"
Major dependency updates
API endpoint changes
Config file format changes

Document clearly:

### Breaking Changes

⚠️ **API Response Format Changed**

The `/api/users` endpoint now returns:

```json
// Before
{ "data": [...] }

// After
{ "users": [...], "total": 100 }
```

Migration: Update your API client to access users instead of data.

## Automation Tools

### Using conventional-changelog
```bash
npm install -g conventional-changelog-cli

# Generate changelog
conventional-changelog -p angular -i CHANGELOG.md -s

# Generate for specific version
conventional-changelog -p angular -i CHANGELOG.md -s -r 0

Using git-cliff

# Install git-cliff
cargo install git-cliff

# Generate changelog
git-cliff --tag v2.1.0 > CHANGELOG.md

# Generate release notes
git-cliff --tag v2.1.0 --unreleased

GitHub Release Script

#!/bin/bash
# scripts/release.sh

VERSION=$1
PREVIOUS_TAG=$(git describe --tags --abbrev=0)

# Generate release notes
gh release create "$VERSION" \
  --title "Release $VERSION" \
  --notes "$(git log $PREVIOUS_TAG..HEAD --pretty=format:'- %s')"

User-Facing vs Developer-Facing

User-Facing (Release Notes)

Focus on benefits and features
Less technical jargon
Include screenshots/demos
Highlight user experience improvements
Provide upgrade instructions

Developer-Facing (Changelog)

Technical details
API changes
Breaking changes with migration guides
Dependencies updates
Internal refactorings

Templates by Project Type

Library/Package

Focus on: API changes, breaking changes, new methods

Application

Focus on: New features, bug fixes, UI improvements

CLI Tool

Focus on: New commands, flag changes, behavior changes

API Service

Focus on: Endpoint changes, performance, security

Best Practices

Be specific : "Fixed login bug" → "Fixed session timeout on mobile"
Link issues : Reference GitHub issues (#123)
Credit contributors : Acknowledge work
Highlight impact : Mark breaking changes clearly
Group logically : By type, not chronologically
Update regularly : With each release
Follow conventions : Keep a Changelog format
Semantic versioning : Use correctly

Changelog Entry Examples

Good Examples

### Added

- OAuth2 authentication support (#456) - @alice
- Export data in CSV format with custom column selection (#501)

### Fixed

- Resolved memory leak in WebSocket connections affecting long-running sessions (#489)
- Fixed race condition in concurrent API requests that caused data inconsistency (#503)

Bad Examples

### Added

- Added stuff
- New feature

### Fixed

- Fixed bug
- Updates

Version Suggestion Algorithm

If breaking changes detected:
  MAJOR++, MINOR=0, PATCH=0
Else if new features:
  MINOR++, PATCH=0
Else if only fixes:
  PATCH++

Release Checklist

Before publishing release:

Review all commits since last release
Identify breaking changes
Categorize changes properly
Update CHANGELOG.md
Write release notes
Update version in package.json/pyproject.toml
Create git tag
Push tag to trigger CI/CD
Publish to package registry (npm, PyPI, etc.)
Create GitHub release with notes
Announce on relevant channels

Output Checklist

Every changelog generation should provide:

Formatted CHANGELOG.md following Keep a Changelog
Release notes draft (user-friendly)
Semantic version suggestion (X.Y.Z)
Breaking changes clearly marked
Migration guide for breaking changes
Git tag command to run
Links to compare view

Weekly Installs

278

Repository

patricio0312rev/skills

GitHub Stars

First Seen

Jan 24, 2026

Security Audits

Gen Agent Trust HubPass SocketPass SnykPass

Installed on

codex272

gemini-cli270

opencode270

github-copilot269

cursor264

amp264

自动化更新日志生成工具 - 基于Git历史智能生成专业更新日志和发布说明

🇨🇳中文介绍

更新日志与发布说明撰写器

核心工作流程

提交记录分析

从以下来源提取信息

解析模式

相关 Skills

更新日志格式（Keep a Changelog）

发布说明格式

🔗 链接

破坏性变更检测

使用 git-cliff

GitHub 发布脚本

面向用户 vs 面向开发者

面向用户（发布说明）

面向开发者（更新日志）

按项目类型的模板

库/包

应用程序

CLI 工具

API 服务

最佳实践

更新日志条目示例

良好示例

不良示例

版本建议算法

发布清单

输出清单