Creating Release Notes

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

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

リリースノートの生成

1. On the top navigation bar, click the white triangle next to 'Projects'. The projects dropdown will display.
   Tip: If you click on the 'Projects' link instead of the triangle, the summary for your current project will display.
2. Click the project that you wish to create release notes for. If it is not displayed in the dropdown, click 'View All Projects' — you will be able to view a list of all projects set up in your JIRA instance and select your project from there.
3. 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.
4. Click 'Release Notes' link for the project version that you wish to generate release notes for. The 'Release Notes' page will display.
5. Click the 'Configure Release Notes' link to configure the release notes. The 'Configure Release Notes' page will display:
   • 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 Jakarta Velocity User Guide.
2. テキスト エリア内のコードとともに、テンプレート内のタイトルを変更する必要があります。テンプレートの他のセクションは変更不要です。
3. Add the new format template to the list within the jira-application.properties file. A corresponding entry must be made in both the jira.releasenotes.templatenames and the jira.releasenotes.templates lists. It is also necessary that the entries in both lists are in the same order.
4. Jira を再起動します。
5. 新しい書式設定テンプレートを、リリースノート書式設定テンプレートとして選択できます。

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