Creating Release Notes

JIRA には、プロジェクトの特定のバージョンのリリースノートを作成する機能があります。リリースノートには、特定の「修正」バージョンとマークされた、指定したプロジェクト内のすべての課題が含まれます。また、リリースノートを多数の形式 (例: HTML、プレーンテキストなど) で生成し、さまざまなドキュメントに含めることもできます。

現在のところ、速度テンプレートを使用した、HTML とテキストの 2 つの書式設定点プレートが提供されています。これ以外にも書式設定テンプレートを作成し、システムに追加できます。

リリースノートの生成

1. Choose > Projects.
2. Select your Project by clicking on it.
3. Click Overview > Road Map on the left of the screen.
   Tip: If you wish to see past release notes click on the 'Change Log' tab instead.
4. Click 'Release Notes' link for the project version whose release notes you wish to generate. The 'Release Notes' page will be displayed.
5. 「リリースノートの構成」リンクをクリックしてリリースノートを構成します。「リリースノートの構成」ページが表示されます。
   
   • Select the required project version for which the release notes will be generated in the 'Please select version' dropdown.
   • Select the required format of the release notes — HTML and plain text format templates are provided in the 'Please select style' dropdown.
6. 「作成」ボタンを選択すると、指定した形式の指定したテンプレートを使用してリリースノートを生成します。リリースノートは画面に表示され、コピーして別のアプリケーションに貼り付けることができます。

新しい書式設定テンプレートの追加

1. Create a Velocity template similar in content to that of the examples provided — releasenotes-text.vm and releasenotes-html.vm. Consult the JIRA API documentation and the Apache Velocity User Guide.
2. テキスト エリア内のコードとともに、テンプレート内のタイトルを変更する必要があります。テンプレートの他のセクションは変更不要です。
3. 新しい書式設定テンプレートを、jira-config.properties ファイルにある既存のテンプレートの一覧に追加します。それぞれの新しいテンプレート形式について、次のプロパティの既存の値に対応する値を追加する必要があります。
   
   • jira.releasenotes.templatenames
   • jira.releasenotes.templates
     
     注意:
     
     1. これらのプロパティの対応するエントリは同じ順序にする必要があります。
     2. これらのプロパティが jira-config.properties ファイルに存在しない場合、次のようにします。
        1. これらの各プロパティに対し、プロパティ名を追加し、
        2. 「=」を続けます。
        3. followed by the content of the property's corresponding <default-value/> element copied from your JIRA installation's jpm.xml file.
        4. 次に、新しい書式設定テンプレートの対応するエントリの追加を開始します。

    See Making changes to the jira-config.properties file for more information.

4. 新しい書式設定テンプレートを、リリースノート書式設定テンプレートとして選択できます。

「リリースコメントを含むカスタムのリリースノートテンプレートの作成」のチュートリアルも参照してください。