Bravo Notes Docs - Search documentation and template examples

Quick start

After installing the Bravo Notes extension from the marketplace you can find a new Bravo Notes icon in the main vertical navigation.

Introduction

Bravo Notes is a product to help you create and distribute information about the software you build using content from work items in Azure DevOps.

While release notes is the most obvious use case, Bravo Notes is also used to create and publish other kinds of documents like weekly reports and documentation.

How it works

At the core Bravo Notes works like this

work items are loaded in one of multiple ways
work items are categorized / labeled via user defined rules (e.g. Bugfixes, New Features)
a user defined template is used to render work item data
either a Markdown, HTML or PDF document is generated

Bravo Notes offers a variety of options and a powerful template syntax that gives you full control over the structure of the final document.

Ways to integrate Bravo Notes in your process

Bravo Notes can be used in two different ways:

Manually generate documents via the Bravo Notes UI

A common scenario for manually generating release notes might look like this:

Titles, descriptions and custom fields of work items included in the current release get some final edits
Your previously created Bravo Notes release notes template is selected
Work items included in the current release are added using a custom work item query
The Export feature is used to generate and download a HTML and a PDF version of the release notes

Automatically generate documents as part of a build / release pipeline

A common scenario for manually generating release notes might look like this:

A build definition is triggered and the Bravo Notes build task is started
Work items associated with the current build (or work items from a defiend query or other source) are loaded
The previously created Bravo Notes template is used to create the document content
A HTML and a PDF document are created
The generated files get published using other build task (e.g. pushed to a web server or sent via email)