creating-changelogs
Gitコミット履歴を分析し、ユーザーフレンドリーかつ技術的に詳細なリリースノートとチェンジログを作成します。リリースノート、CHANGELOG、変更履歴が必要なときに使用してください。
When & Why to Use This Skill
This Claude skill automates the generation of professional release notes and changelogs by analyzing Git commit history. It intelligently categorizes updates—such as features, bug fixes, and breaking changes—into structured documentation, bridging the gap between technical development logs and user-friendly communication for stakeholders.
Use Cases
- Automated Version Documentation: Generate a comprehensive CHANGELOG.md file for new software releases by scanning Git tags and commit ranges.
- User-Facing Release Notes: Transform technical commit messages into readable, high-level summaries for product blogs, newsletters, or customer-facing documentation.
- Internal Sprint Reporting: Provide engineering managers with a statistical overview of development progress, including the volume of features, fixes, and refactoring tasks completed.
- Breaking Change Identification: Automatically detect and highlight critical API changes and migration steps to ensure smooth transitions for developers and end-users.
- Deployment Readiness: Create detailed deployment notes including database migrations and environment variable changes to facilitate safer production releases.
| name | creating-changelogs |
|---|---|
| description | Gitコミット履歴を分析し、ユーザーフレンドリーかつ技術的に詳細なリリースノートとチェンジログを作成します。リリースノート、CHANGELOG、変更履歴が必要なときに使用してください。 |
| allowed-tools | Read, Bash, Grep, Glob, Write |
チェンジログ作成
Quick Start
- 対象バージョン/期間を確認
- Git履歴を取得・分類
- テンプレートに沿って出力
ワークフロー
Step 1: 範囲特定
# タグ間の履歴
git log v1.0.0..v1.1.0 --oneline
# 日付範囲
git log --since="2024-01-01" --until="2024-01-31" --oneline
# 最新N件
git log -20 --oneline
Step 2: コミット分類
| カテゴリ | 識別パターン | 絵文字 |
|---|---|---|
| 新機能 | feat:, add:, new: |
🎉 |
| 改善 | improve:, enhance:, update: |
✨ |
| バグ修正 | fix:, bugfix: |
🐛 |
| パフォーマンス | perf: |
⚡ |
| リファクタリング | refactor: |
♻️ |
| ドキュメント | docs: |
📝 |
| テスト | test: |
✅ |
| インフラ/CI | ci:, chore:, build: |
🔧 |
| セキュリティ | security: |
🔒 |
| 破壊的変更 | BREAKING:, !: |
⚠️ |
Step 3: 情報整理
- 関連コミットをグループ化
- ユーザー影響の大きい順に並べ替え
- 破壊的変更を特定
Step 4: 出力生成
- テンプレートに沿って記述
- ユーザー向け/開発者向けの両面を記載
出力テンプレート
# Changelog - v[X.Y.Z] ([YYYY-MM-DD])
## 🎯 ハイライト
このリリースの主要な成果(1〜3文)
## 📊 統計
- 新機能: X件
- バグ修正: Y件
- 改善: Z件
---
## 🎉 新機能
### [機能名]
**ユーザーへの影響**: [何ができるようになったか]
**技術詳細**: [実装アプローチ、変更ファイル]
---
## ✨ 改善
### [改善内容]
[説明]
---
## 🐛 バグ修正
### [修正内容]
**問題**: [何が壊れていたか]
**解決**: [どう修正したか]
---
## ⚠️ 破壊的変更
### [変更内容]
**影響**: [何が変わるか]
**移行ガイド**:
1. [手順1]
2. [手順2]
---
## 🚀 デプロイメントノート
- **DB マイグレーション**: [必要/不要]
- **環境変数**: [追加/変更があれば記載]
- **依存関係**: [更新があれば記載]
対象読者別の記述ガイド
ユーザー向け(非技術者含む)
- 変更がもたらす具体的なメリット
- 専門用語を避けたわかりやすい説明
- 操作方法の変更があれば明記
開発者向け
- 実装の詳細とアーキテクチャ変更
- 影響を受けるファイル/モジュール
- API変更とコード例