リリースノートジェネレーター

バージョン情報、変更エントリ、コントリビューターから構造化されたリリースノートを作成。Markdown、HTML、プレーンテキストでエクスポートできます。

このツールについて

リリースノートジェネレーターは、ソフトウェアプロジェクトのプロフェッショナルで 構造化されたリリースノートを作成する無料のブラウザベースツールです。 手動でチェンジログエントリをフォーマットする代わりに、バージョン詳細を入力し、 カテゴリ別の変更エントリ(Added、Changed、Deprecated、Removed、Fixed、 Security)を追加すると、選択したフォーマットで適切にフォーマットされた出力を生成します。

ジェネレーターは3つの人気テンプレートをサポートしています。Keep a Changelogは 広く採用されているkeepachangelog.comの規約に従い、 セマンティックバージョニングヘッダーとグループ化されたカテゴリを使用します。 GitHub ReleaseはGitHubのリリース機能に最適化された出力を生成し、 ハイライトセクションとコントリビューターの記載を含みます。 Conventional Changelogconventional-changelogstandard-versionなどの ツールで使用されるフォーマットに従います。

Conventional Commitsをワークフローで使用している場合は、 Conventional Commits Linterでコミットメッセージの 検証ができます。リリースプロセス全体の自動化には、 Semantic Release Config Builderをご覧ください。

すべての処理はブラウザ内で完全に実行されます。バージョン情報、変更説明、 コントリビューター情報がサーバーに送信されることはありません。

使い方

  1. バージョン情報セクションでバージョン番号(例:2.0.0)、リリース日、オプションのコードネームを入力します。
  2. このリリースで最も重要な変更を説明するリリースハイライトの概要を記述します。
  3. 破壊的変更がある場合は、Breaking Changesセクションに記載して出力で目立つように表示します。
  4. カテゴリ(Added、Changed、Deprecated、Removed、Fixed、Security)を選択し、説明を入力し、オプションでPRやissueのリンクを付けて変更エントリを追加します。
  5. コントリビューターセクションを展開して、オプションのプロファイルURLとともにチームメンバーやコミュニティコントリビューターを追加します。
  6. テンプレート(Keep a Changelog、GitHub Release、Conventional Changelog)と出力フォーマット(Markdown、HTML、プレーンテキスト)を選択します。
  7. 右パネルで生成された出力を確認します。CopyをクリックするかCtrl+Shift+Cを押してコピーするか、Downloadをクリックしてファイルとして保存します。

人気のリリースノート例

すべてのリリースノート例を見る →

よくある質問

Keep a Changelog形式とは何ですか?

Keep a Changelogは、変更をカテゴリ(Added、Changed、Deprecated、Removed、Fixed、Security)に分類し、日付付きバージョンヘッダーの下にグループ化するチェンジログ記述の規約です。セマンティックバージョニングに従い、keepachangelog.comで説明されています。このツールはこの広く採用されている標準に準拠した出力を生成します。

どの出力フォーマットに対応していますか?

ツールは3つのフォーマットでリリースノートを生成します:Markdown(READMEファイル、GitHubリリース、ドキュメントで最も一般的)、HTML(Webページやメールへの埋め込み用)、プレーンテキスト(ターミナル出力、メール、シンプルなテキストファイル用)。

変更エントリにPRやissueのリンクを追加できますか?

はい。各変更エントリにはオプションのリンクフィールドがあり、PR番号(#123など)、完全なURL、または任意の参照を入力できます。リンクは選択した出力フォーマットに応じて適切にフォーマットされます。

3つのテンプレートオプションは何ですか?

Keep a Changelogは[version] - date形式のヘッダーとグループ化されたカテゴリの標準的なフォーマットを使用します。GitHub ReleaseはH1ヘッダー、ハイライトセクション、GitHubリリース機能に最適化されたフォーマットを生成します。Conventional Changelogはconventional-changelogツールで使用されるフォーマットに従います。

破壊的変更は出力でどのように表示されますか?

破壊的変更は、Markdownではブロッククォート、HTMLではblockquote要素、プレーンテキストでは明確にラベル付けされたセクションとして、BREAKING CHANGESの専用セクションで目立つように表示されます。

データは安全ですか?

はい。すべてのリリースノート生成はJavaScriptを使用してブラウザ内で完全に実行されます。バージョン情報、変更説明、コントリビューター詳細などのデータがサーバーに送信されることはありません。ブラウザの開発者ツールのネットワークタブで確認できます。

ソフトウェア以外のプロジェクトにも使えますか?

もちろんです。カテゴリはソフトウェアリリースの規約に従っていますが、構造化されたアップデートノートが必要なあらゆるプロジェクトに使用できます。API、ドキュメント、デザインシステム、さらにはハードウェア製品のアップデートにも適用できます。

関連ツール