Creating Release Notes

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

JIRA provides the functionality to create release notes for a specific version of a project. The release notes contain all issues within the specified project that are marked with a specific "Fix For" version. The release notes can also be generated in a number of formats (e.g. HTML, plain text, etc.) so as they can be included in various documents.

At present, two example format templates are provided - HTML and Text - using Velocity templates. Further format templates can be created and added to the system.

Generating Release Notes

  1. Choose  > Projects, and click the name of a project.
  2. Click Overview > Road Map on the left of the screen.
  3. Select your Project by clicking on it.
    (tick) 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. 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.
  6. Selecting the 'Create' button will generate the release notes using the specified template in the specified format. The release notes will be displayed on screen and can be copied and pasted to another application.

Last modified on Apr 15, 2014

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.