コミットと差分からリリースノートを作成

コミットの件名や unified diff を貼り付けると、変更をグループ分けしたリリースノート草案と推奨バージョンレベルを作成します。バージョンの最終判断は利用者に委ねられます。

ブラウザ内でローカルに実行
このツールの処理はすべてブラウザ内で行われます。KivTools が入力内容をアップロード・保存したり、外部 API に送信したりすることはありません。
コミットまたは Git 差分Conventional Commits、git log の件名、または unified diff のテキストを貼り付けます。
Markdown リリース下書き
ツールを実行すると、ローカルで処理した結果がここに表示されます。

コミットや diff からリリースノートを作る方法

Conventional Commit の件名 — git log --oneline からそのままコピーしても構いません — または unified diff を貼り付けると、変更をグループ分けした Markdown のリリース下書きと、major / minor / patch の推奨レベルに変換します。

リポジトリには一切触れません。貼り付けたテキストはブラウザ内で解析され、サンプルボタンで例を読み込め、コピーまたはダウンロードで release-notes.md として取り出せます。

  1. 「コミットまたは Git 差分」にテキストを貼り付けます。1 行に 1 つの Conventional Commit 件名、git log --oneline のリスト、または diff --git ヘッダー付きの unified diff を入力します。
  2. 「リリースノートを生成」を押します。コミット件名でも diff 内容でもない行 — 著者、日付、hunk マーカー — は読み飛ばされます。
  3. 下書きを確認します。コミットは新機能、修正、パフォーマンス、変更、ドキュメント、テスト、ビルドと CI にグループ分けされ、! 付きまたは BREAKING CHANGE フッター付きのコミットには印が付きます。
  4. 推奨レベルを確認します。互換性のない変更が印付きなら major、feat があれば minor、それ以外は patch です。最終的なバージョン番号はあなたが決めるため、下書きでは「推奨」と表現します。
  5. コピーまたはダウンロードで結果を取り出し、クリアで両方の欄を空にします。

このページが読み取るもの、あなたに委ねるもの

認識される内容

コミット件名には短い・長いハッシュ接頭辞を任意で付けられます。abc1234 feat: … も 40 文字の完全なハッシュもコミットとして読み取ります。スコープは保持され、feat(api): add filters はスコープを括弧に入れて新機能へ入ります。

タイプは Conventional Commits の一式 — feat、fix、docs、style、refactor、perf、test、build、ci、chore — に revert を加えたものです。diff 入力には本物の diff --git ヘッダーが必要で、変更ファイル一覧と + / − の行数はヘッダーより後の行からのみ集計します。本文中の単独の + は追加行として数えません。

バージョンレベルは推奨にすぎません

major = ! 付きまたは BREAKING CHANGE フッターが 1 つ以上、minor = feat が 1 つ以上、patch = それ以外(docs、テスト、style、chore を含む)。機械的なルールなので、タグを打つ前に下書きを読んでください。

推奨行は下書き内のただのテキストで、どこにも公開されません。このページが生成するのは出力だけです。

このページがしないこと

Git リポジトリを読んだり、git を実行したり、ネットワークサービスを呼んだりしません。解析するのは貼り付けたテキストだけです。

この 2 形式以外は推測せずに通知します。空欄には貼り付けの案内を返し、コミット件名も diff 内容もないテキストには専用のメッセージを返します。git diff --stat の要約やバイナリ diff は行数統計に変換しません。

最近使ったツール: