gen-changelog について
gen-changelogは、現在のブランチとmainの差分からchangelogを作成し、ドキュメントサイトへ同期するスキルです。パッケージ別の記録、中国語訳、破壊的変更の専用形式にも対応します。
主な機能
- 01ブランチとmainの変更を比較
- 02ユーザー向けchangelog項目の作成
- 03パッケージ別changelogの更新
- 04英語版changelogをドキュメントへ同期
- 05項目を中国語に翻訳
- 06破壊的変更を記録
活用シーン
- 01ブランチ変更からリリースノートを準備
- 02パッケージ固有の変更を記録
- 03破壊的変更の移行手順を説明
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ moonshotai/ kimi-cli --skill gen-changelogインストール後、Claude Code で/gen-changelogを入力して読み込まれたか確認します。
詳細
現在のブランチの変更点を main と比較して変更履歴の項目を作成し、ドキュメントサイトに同期します。
手順
- 確認:
git log main..HEAD --onelineとgit diff main..HEAD --statを実行します。 - ルートの CHANGELOG を編集:以下のプレフィックス表を使って、
CHANGELOG.mdの## Unreleasedの下に箇条書きを追加します。packages/またはsdks/配下のサブパッケージに関する変更については、そのサブパッケージのCHANGELOG.mdも更新します。サブパッケージの CHANGELOG は、それぞれ独自のプレフィックス規則に従います(例:packages/kosong/CHANGELOG.mdではKimi:/Anthropic:などのプロバイダープレフィックスを使用します)。以下の表に従うのはルートの CHANGELOG のみです。 - 英語のドキュメントを同期:
node docs/scripts/sync-changelog.mjsを実行します。 - 中国語に翻訳:
docs/zh/release-notes/changelog.mdの## 未发布の下に、手作業で対応する項目を記述します。全角コロン:を使用してください。用語はdocs/AGENTS.mdに従います。 - 破壊的変更:該当する変更がある場合は、
docs/en/release-notes/breaking-changes.mdの## Unreleasedの下に、Affected と Migration のサブセクションを追加します。また、docs/zh/release-notes/breaking-changes.mdの## 未发布の下に、受影响 と 迁移 のサブセクションを追加します。
項目の形式
- <Prefix>: <verb-led sentence, readable standalone> — <optional rationale / before-after / migration>
- 最初の文だけで完結させる — 読者が、その項目が自分に関係するかどうかを一文で判断できるようにします。
- 1 つの箇条書きにつき 1 つの変更。
; also、; and、入れ子の em ダッシュは使わないでください。変更が 2 つある場合は、箇条書きも 2 つにします。 - 動詞で始める:
Fix …/Add …/Switch …/Bump …。 - ユーザーにとって意味のある変更のみ。内部リファクタリング、テストの変更、CI の調整は含めません。ただし、SDK 向けの変更には
Lib:を使用します。
プレフィックス — このリストから選び、新しいものを作らないでください
| プレフィックス | 対象範囲 |
|---|---|
Shell | 対話型 TUI:キー、ステータスバー、スラッシュコマンド、ターミナルの描画 |
Web | kimi web |
Vis | kimi vis トレースビジュアライザー |
CLI | トップレベルのフラグ、サブコマンド、--print / --yolo / --afk |
ACP | Zed / JetBrains およびその他の ACP 統合 |
Core | エージェントのランタイム、ステップループ、承認、クォータ、ターン、バックグラウンドタスク |
Tool | 組み込みツール全般。本文では具体的なツール名(ReadFile、Grep、Todo、Plan など)を記載します |
Skill | スキルの検出/読み込み、Flow、Loop(常に単数形を使用し、Skills: とはしないでください) |
MCP | MCP サーバーの統合 |
Plugin | プラグインシステム、kimi plugin サブコマンド |
LLM | プロバイダーに依存しない変更、または複数のプロバイダーにまたがる変更。本文ではプロバイダー名(Kimi / Anthropic / OpenAI / DeepSeek など)を記載します。プロバイダーごとのプレフィックスは作成しないでください |
Kosong | ルートの CHANGELOG に記載する kosong LLM 抽象化レイヤーの変更(サブパッケージ独自の CHANGELOG ではプロバイダーのプレフィックスを使用します) |
Wire | ワイヤープロトコルのイベント、バージョン |
Auth | OAuth、トークンの更新、/login |
Config | 設定スキーマ、環境変数 |
Lib | SDK 向け API の変更 |
Build | Nix / Rust / Python / パッケージング |
判断に迷う場合は、同種の既存項目に合わせてください。このリストを優先してください。本当に新しいプレフィックスが必要な場合は、メンテナーに相談し、同じ PR でこの表も更新して、規則を一元管理してください。
順序:各バージョン内では、表の順にプレフィックスごとに箇条書きをまとめます。プレフィックス内の順序は自由です。開発順を維持してください。
ハイライト
次のリリースから、各バージョンの見出しの下に **Highlights**: … を追加します(多くのユーザーが気づく項目を 1〜3 件)。中国語では **亮点**:… として同様に記載します。内部変更のみ、または Lib: のみのリリースでは省略してください。ハイライトは要約です。ハイライトした項目も、下に完全な箇条書きで記載する必要があります。過去のバージョンには追加しないでください。
コメント
Markdown 対応