How to view Azure DevOps Releases in Confluence

The how-to guide on how to add and view Azure DevOps Releases in a Confluence page

Using the Azure DevOps Releases macro

You need to ensure the Releases can be accessed by the user who created the personal access token and the Releases (Read) access scope is provided. Talk to your Confluence admin if unsure.

This macro provides an easy way to view the status of Azure DevOps Releases by embedding them in Confluences pages.

Quick Guide

1. Copy the Azure DevOps Release URL

2. Paste the Azure DevOps Release URL into a Confluence page.

Detailed Guide

Here is an example of how the macro looks in Confluence

To add a Releases macro to Confluence, you require the Azure DevOps Release URL.

If you wish to display all Releases in a Pipeline, go the Azure DevOps releases section, select the pipeline in question as shown below, then copy the URL from the browser.

The URL should be in the following format: <BASE_URL>/<ORG>/<PROJECT>/<PROJECT_NAME>/_release?<PARAMETER>/<ID>

If you wish to display an individual Release, then select the Release in question as shown below, then copy the URL from the browser.

The URL should be in the following format: <BASE_URL>/<ORG>/<PROJECT>/<PROJECT_NAME>/_releaseProgress?<PARAMETER>/<ID>

If you are using Microsoft Azure DevOps running On-Premise, you need to make sure you are using the URL accessible from the Internet.

How to Add the Releases Macro

The easiest way to add a Releases Macro to a Confluence page, is to simply paste the Azure DevOps Releases URL into a Confluence page and the macro should populate automatically.

Alternatively, you can open a blank Releases Macro instance in one of two similar ways.

Typing / followed by the Macro name (e.g. /Release) as shown, the macro will populate, allowing you to select it

This can also be achieved by typing the name into the ‘Insert elements’ drop down and selecting the macro.

Configuring the Releases Macro

To access the macro configuration sidebar, either click on a newly added blank Releases macro, or alternatively click on an existing Releases macro, then click the edit button as shown below

Both options will open the Azure DevOps Releases configuration sidebar to the right.

Url

This is the link to the Azure DevOps Release(s) you wish to display.

Items count

This allows you to limit the number of rows that will be displayed when showing all releases from a pipeline.

Demo

You can find a demo of the Releases macro from YouTube below:

Note: The section covering the Releases macro begins at 1:45.

Updated: 18 Dec 2024