Back to skills
extension
Category: Development & EngineeringNo API key required

creating-changelogs

Analyze the Git commit history and create user-friendly and technically detailed release notes and changelogs. Use when you need release notes, CHANGELOG, or change history.

personAuthor: jakexiaohubgithub

チェンジログ作成

Quick Start

  1. 対象バージョン/期間を確認
  2. Git履歴を取得・分類
  3. テンプレートに沿って出力

ワークフロー

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変更とコード例