Skip to content

What is an Entry in Release Notes for DevOps

In short, when you are in the Release Notes Hub, you can create entries there. Whether it's a Release Note, Known Issue, or an Upcoming Feature entry. These entries are then used to, for example, create a Release Note for your customers.

How does it work

The goal of our extension is to write clean and appropriate Release Notes, Known Issues, or Upcoming Features. To integrate this into the Azure DevOps process, there are Work Items where work packages are already defined. Our extension seamlessly integrates into the work item and a new tab "Release Note" is available. In this tab, a release note is then written for this work item.

This has the advantage that a dedicated area has been created to clearly separate the description from the work item, with the description of, for example, a Release Note, to create a neat and structured possibility to create a Release Note, Known Issue, or an Upcoming Feature entry.

More information about the Release Note Tab extension can be found here: Release Note Tab Extension

These created "items" are then imported into the desired entries and personalized there via various configuration options in the respective entry and then exported if desired.

Status of an Entry

You can find your Release Note entries under Active, Pipeline, or Released.

image

Active Pipeline Released
Here, the release note entries that are currently being processed are listed. This status is defined when creating an entry from the Hub. Here, the created entries from our build task are listed. The Released status helps you to better structure your entries. You can set the status of the entries to release as soon as you have published this release note, for example.

In addition to the Released Status, you will find the Known Issues and Upcoming Features tabs by default. There is no status per entry here, as each entry is always active. Why and why not is explained in the documentation under the respective Extension.

See also