Creating Release Notes

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

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

リリースノートの生成

1. Click 'Projects' and select the project of interest.
2. Click 'Road Map' tab on the left of the screen.
   Tip: If you wish to see past release notes click on the 'Change Log' tab instead.
3. Click 'Release Notes' link for the project version whose release notes you wish to generate. The 'Release Notes' page will be displayed.
4. Click the 'Configure Release Notes' link to configure the release notes. The 'Configure Release Notes' page will be displayed:
   • 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.
5. 「作成」ボタンを選択すると、指定した形式の指定したテンプレートを使用してリリースノートを生成します。リリースノートは画面に表示され、コピーして別のアプリケーションに貼り付けることができます。

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

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. Add the new format template to the list of existing ones within the jira-config.properties file. For each new template format, corresponding entries must be added to the existing values of the following properties:
   • jira.releasenotes.templatenames
   • jira.releasenotes.templates
     Corresponding entries in both of these properties must be in the same order.
     If these properties do not exist in your jira-config.properties file, then for each of these properties, add the property's name, followed by an '=', followed by the content of the property's corresponding <default-value/> element copied from your JIRA installation's jpm.xml file. Next, begin adding the corresponding entries for the new format template.
     See Making changes to the jira-config.properties file for more information.
4. 新しい書式設定テンプレートを、リリースノート書式設定テンプレートとして選択できます。

Also see the tutorial on How to Create a Custom Release Notes Template Containing Comments.