Building release notes
You can build a text-based release notes file to include in a Read Me file or distribute to customers when you release your product. These files include information collected from workflow events configured to be included with release notes. See Adding workflow events.
Tip: To see which issues contain release notes, add the Has Release Notes column to the Issues list window.
1. To generate release notes for all issues, choose File > Build Release Notes.
To generate notes for specific issues, select them in the Issues list window first.
The Build Release Notes dialog box opens.
2. Enter the From version and the Through version to include in the notes.
If the notes are specific to one version, enter the same version number in both fields.
3. Select a filter from the Use Filter list to generate notes for issues that pass the filter.
4. Select a product from the Limit to Product list to generate notes for a specific product.
5. Select Only include issues selected in the issue list to include only the issues you selected in the Issues list window.
6. Select any Presentation Options.
- Sort versions from newest to oldest sorts the notes in order starting with the newest version.
- Insert a blank line between each release note adds an empty line between each note.
- Begin each release note with starts each note with the specified character. You can enter alphanumeric and ASCII characters or leave the field empty.
7. Click Preview to preview the notes.
The Release Notes preview dialog box opens. You can search for text in the notes. You can also print or save the preview to use a reference if you need to make any changes. Click Close when you finish.
If you need to make changes before generating the final notes, you can update the settings. You may also be able to edit the individual workflow events to modify the content. See Editing and deleting workflow events on items.
8. Click Create and Save.
The Save Release Notes As dialog box opens.
9. Choose a location to save the file in and enter a File name.
The default file name is Release Notes.txt.
10. Click Save.
The release notes are generated and saved as a text file.
