リリース ノートを作成する
Jira には、プロジェクトの特定バージョンに対するリリース ノートを作成する機能があります。リリース ノートには、特定の「修正」バージョンとマークされた、指定したプロジェクト内のすべての課題が含まれます。
リリース ノートはプレーン テキストや HTML などさまざまな形式で生成することもできるため、各種文書に含めることができます。
プレーン テキストの形式で作成されたリリース ノートの例:
初期設定で、Jira ではリリース ノート用に HTML テンプレートと Text テンプレートという 2 つのカスタマイズされた Velocity テンプレートが用意されています。また、独自のテンプレートを作成し、それらをシステムに追加することもできます。詳細については、「リリース コメントを含むカスタムのリリース ノート テンプレートを作成」を参照してください。
以下のテンプレートは、<jira-application-dir>/WEB-INF/classes/templates/jira/project/releasenotes の下にあります。
releasenotes-text.vmreleasenotes-html.vm
リリース ノートの表示と作成は、リリース バージョンが有効になっているプロジェクトでのみ行えます。プロジェクトのバージョンが何も作成されていない場合、リリース ノートの設定や生成を行うことはできません。
リリース ノートの生成
上部のナビゲーション バーから、[プロジェクト] > [すべてのプロジェクトの表示] の順に移動し、プロジェクトを見つけます。
プロジェクトのサイドバーで、[リリース] を選択します。
Jira Core を使用している場合、[プロジェクト設定] に移動し、[バージョン] を選択します。
リリース ノートを生成するバージョンを開きます。
[リリース ノート] を選択します。
- [リリース ノートの設定] リンクを選択し、リリース ノートをカスタマイズします。
[バージョンを選択してください]: リリース ノートの生成に必要なプロジェクトのバージョンを選択してください。
[スタイルを選択してください]: リリース ノートに必要な形式を選択するか、使用可能ないずれかのプレーン テキスト形式テンプレートを使用してください。
[作成] を選択し、指定した形式の指定したテンプレートを使用したリリース ノートを生成します。リリース ノートが画面に表示されます。これらは、別のアプリケーションにコピーして貼り付けることができます。
新しい書式設定テンプレートの追加
- 例として提供された
releasenotes-text.vmおよびreleasenotes-html.vmに似た内容の Velocity テンプレートを作成します。Jira API ドキュメントおよび Apache Velocity ユーザー ガイドを参照してください。 - テキスト エリア内のコードとともに、テンプレート内のタイトルを変更する必要があります。テンプレートの他のセクションを変更する必要はありません。
- 新しい書式設定テンプレートを、
jira-config.propertiesファイルにある既存のテンプレートの一覧に追加します。それぞれの新しいテンプレート形式について、次のプロパティの既存の値に対応する値を追加する必要があります。jira.releasenotes.templatenamesjira.releasenotes.templates注意:
- これらのプロパティの対応するエントリは同じ順序にする必要があります。
- これらのプロパティが
jira-config.propertiesファイルに存在しない場合、次のようにします。- これらの各プロパティに対してプロパティ名を追加します。
- 「
=」と続けます。 - 続けて、Jira インストールの
jpm.xmlファイルからコピーした、プロパティに対応する<default-value/>要素の内容を入力します。 - 次に、新しい書式設定テンプレートに対応するエントリの追加を開始します。
詳細は「
jira-config.propertiesファイルに変更を加える」をご参照ください。
- 新しい書式設定テンプレートを、リリース ノート書式設定テンプレートとして選択できます。詳細については、「リリース コメントを含むカスタムのリリース ノート テンプレートの作成」を参照してください。