Changelog

To edit a changelog, click on the desired changelog in the changelog overview. You'll be taken to the changelog detail page, where you can customize your changelog. Here you can import release notes, adjust the order, fill placeholders, apply labels, and modify the changelog's metadata.

Saving the Changelog

If you've made changes that need to be saved, a blue "Save" action will appear in the upper right corner. Please be sure to save your changelog after making changes, otherwise your changes will be lost.

Tab Bar

All these options are organized into distinct groups using the Tab bar.

Release Notes Tab

This tab lists all imported release notes for the changelog. The import process can be better understood here.

The imported release notes table is structured as follows:

ID	Title	Area
The ID indicates the associated work item ID of the release note, along with the work item type represented by an icon	The title represents the title of the release note.	The area displays the corresponding work item area of the release note.

In addition to the Import action, you'll also find a Clear action, which removes all release notes from the changelog, and a Settings button.

The settings action opens the Table configuration, where you can customize the appearance of the table.

• Display Area

  This allows you to choose whether or not to display the Area column.

• Display Parent Element

  This is where an element is assigned to the title if the work item of the release note has a parent reference.

Sequence

The Sorting section allows you to define a custom sorting order for the selected changelog.

The sorting is divided into three points: Sort by Work Item Area, Sort by Parent Work Item, and Sort by Work Item Type.

Important

These different sorting methods are structured hierarchically. Release Notes are sorted first by area, then by parent reference, and finally by type.

1. Area sequencing sorts release notes by work item area names.
2. Parent order sorts release notes by work item parent references.
3. Type order sorts release notes by work item type names.

Once you enter a sequencing option, you'll see the same configuration choices over and over again:

1. Activation of sequencing.
2. Enabling headers for grouping.
3. Defining the individual sorting order.

Within the Individual sorting section, a table is displayed if data exists. This table displays the "Group" name and the number of associated children.

To create your custom sort order, use drag and drop to arrange items as desired.

Placeholder

This tab displays created placeholders. Here you can customize the placeholder values for the current changelog. If you do not see any placeholders, you need to create them in the placeholder settings.

Preview:

Labels

This tab mirrors the label configuration options from the label settings. Here you can manage and store only labels specific to the changelog. For more information about labels in Release Notes for DevOps, click here.

Options

This tab allows you to customize your changelog data. You'll find fields for title, version, and description. Some of this changelog metadata is available in the changelog overview. Make any necessary adjustments here and save them.

Under "Template Components", you can decide whether to include a cover and table of contents in the changelog. If these options are disabled, they won't be included in the changelog.

At the bottom you'll find a red button to delete your changelog.

Changelog Preview

Next to the selected Options tab is the changelog preview. This provides a real-time representation of your current changes within the preview, giving you an ongoing visual assessment of your changelog's appearance.

Here's a sample preview: