スキル: changelog
Git履歴からバージョンごとにグループ化し、機能タイプ別に分類されたチェンジログを作成または更新します。
トリガー
/changelog- チェンジログを作成または更新- 「チェンジログを作成して」「チェンジログを更新して」「何が変更された?」
パラメータ
指定がない場合は、ユーザーに以下の情報を確認してください。
-
対象読者(標準ファイルも決定)
- エンドユーザー →
Changelog.md(簡略化、利点を説明) - 開発者 →
Changelog-Dev.md(技術的、コミット詳細付き)
- エンドユーザー →
-
モード
- 更新(デフォルト):最後のエントリ以降の新規変更のみ追加
- 新規作成:特定の時点からの完全なチェンジログを作成
-
期間(「新規作成」の場合のみ)
- 例:「2025年3月以降」「v2.3.0以降」
ワークフロー
1. 既存のチェンジログを確認
# チェンジログが存在するか確認
ls Changelog.md Changelog-Dev.md 2>/dev/null
チェンジログが存在する場合:
- 最後に記録された状態(バージョンまたはコミット)を特定
- マーカー
## 🔮 開発中の後に最後の既知のコミットを検索 - または、最後に記録されたInsiders/Stableバージョンを参照として使用
2. Gitデータを収集
# タグと日付を取得
git for-each-ref --sort=-creatordate --format='%(refname:short) %(creatordate:short)' refs/tags
# 最新タグを特定
git describe --tags --abbrev=0
# 最新タグ以降のコミット(「開発中」用)
git log $(git describe --tags --abbrev=0)..HEAD --pretty=format:"%h %ad %s" --date=short
# 特定バージョン以降のコミット
git log v2.3.0..HEAD --pretty=format:"%h %ad %s" --date=short
3. コミットを分類
コミットメッセージを分析し、以下のように分類します。
| カテゴリ | キーワード |
|---|---|
| 新機能 | Add, Feat, Feature, New, Implement |
| バグ修正 | Fix, Bugfix, Hotfix, Resolve |
| パフォーマンス | Performance, Optimize, Speed |
| 技術的変更 | Bump, Update, Refactor, Chore, Deps |
無視するもの:
- マージコミット(「Merge branch」「Merge pull request」)
- リリースコミット(「Release v」「Bump version」)
- WIPコミット、ビルド修正
4. バージョンを割り当て
重要: 機能は以下のフェーズを順に通過します。
🔮 開発中 → 🧪 Insiders → ✅ Stable
(展望) (アーリーアダプター) (全ユーザー)
- 機能は1つのフェーズにのみリストできます
- Stableにある場合、以前はInsidersにありました
- Insidersにある場合、以前は開発中にありました
- 各セクションは、以前のバージョンからの新規変更のみを表示します
5. チェンジログを更新
更新時:
- 既存ファイルを読み込む
- 「開発中」セクションに新しいコミットを追加
- 新しいリリース時:「開発中」→「Insiders」または「Insiders」→「Stable」に移動
- ファイルを保存
新規作成時:
- すべてのバージョンを含む完全なテンプレートを作成
標準ファイル
| 対象読者 | ファイル | 内容 |
|---|---|---|
| エンドユーザー | Changelog.md | 利点を説明、技術的詳細なし、コミットハッシュなし |
| 開発者 | Changelog-Dev.md | 技術的詳細、コミットハッシュ、PR番号、破壊的変更 |
出力テンプレート(エンドユーザー)
# チェンジログ [プロジェクト名]
---
## 🔮 開発中(次期リリースの展望)
*これらの機能は [最終タグ] 以降に追加され、次期リリースに含まれます。*
### 新機能
- エンドユーザー視点での機能説明
### バグ修正
- エンドユーザー視点での修正説明
---
## 🧪 Insiders vX.Y.Z-insiders.N (YYYY.MM.DD)
*Stable vX.Y.Z に比べて新機能を含むプレビューバージョン。*
### 新機能(vX.Y.Z からの変更点)
- 機能説明
---
## ✅ Stable vX.Y.Z (YYYY.MM.DD)
*安定版 - vX.Y.Z-insiders.1 から vX.Y.Z-insiders.N までの全機能を含みます。*
### 新機能(vX.Y-1.Z からの変更点)
- 機能説明 *(insiders.N 以降)*
### バグ修正(vX.Y-1.Z からの変更点)
- 修正説明 *(insiders.M 以降)*
---
## リリースプロセス
機能は全ユーザーに届くまでに3つのフェーズを経ます。
🔮 開発中 → 🧪 Insiders → ✅ Stable (展望) (アーリーアダプター) (全ユーザー)
| フェーズ | 対象読者 | 説明 |
|---------|----------|------|
| 🔮 **開発中** | 開発者 | 今後の機能の展望。まだどのリリースにも含まれていません。 |
| 🧪 **Insiders** | アーリーアダプター | Stableリリース前に新機能をテストするためのプレビューバージョン。 |
| ✅ **Stable** | 全ユーザー | プロダクション品質のバージョン。機能は完全にテストされリリースされています。 |
**注意:** 各セクションは、そのフェーズで**新しく**追加された変更のみをリストします。
出力テンプレート(開発者)
# チェンジログ(開発者)
---
## 🔮 開発中
*[最終タグ] 以降のコミット*
### 新機能
- `abc1234` 機能Xを追加 (#123)
### バグ修正
- `def5678` バグYを修正 (#456)
### 技術的変更
- `ghi9012` 依存関係Zを更新
---
## 🧪 Insiders vX.Y.Z-insiders.N (YYYY.MM.DD)
### 破壊的変更
- 破壊的変更の説明
### 新機能
- `abc1234` 機能説明 (#123)
### バグ修正
- `def5678` 修正説明 (#456)
---
## ✅ Stable vX.Y.Z (YYYY.MM.DD)
*Insiders .1 から .N までを含む*
### 破壊的変更
- 説明
### コミット
- 前回のStable以降の全コミットリスト
例
例1: チェンジログを更新(標準)
ユーザー: 「チェンジログを更新して」
手順:
Changelog.mdが存在するか確認- 最後に記録された状態を特定
git log [最終状態]..HEAD --pretty=format:"%h %ad %s" --date=short- 新しいコミットを分類
- 「開発中」セクションを更新
例2: 開発者向けチェンジログ
ユーザー: 「開発者向けチェンジログを作成して」
手順:
Changelog-Dev.mdが存在するか確認- コミットハッシュとPR番号を含むGit履歴を収集
- 技術的詳細と破壊的変更を文書化
Changelog-Dev.mdに保存
例3: 新しいリリースを文書化
ユーザー: 「v2.4.0-insiders.3をリリースしました」
手順:
- Changelog.md を読み込む
- 「開発中」の内容を「Insiders v2.4.0-insiders.3」に移動
- 新しい空の「開発中」セクションを作成
- 日付を追加
ヒント
- 長いコミットメッセージの場合は最初の文を使用
- PR番号 (#123) は開発者向けチェンジログのみに保持
- 関連するコミットはグループ化(例:1つの機能に対する複数のコミット)
- コミットが多い場合は
headコマンドで出力を制限 - 更新時は常に既存のチェンジログをベースとして使用