Overview

Every Release of an Extension in the Extension Gallery can include Release Notes — information that tells users what changed, what's new, or where to find more details about that specific release.

Release Notes support two complementary ways of providing information:

• Markdown content: write your changelog, new features, or upgrade notes directly in the editor.
• External links: point users to existing documentation (e.g., a knowledge base article, a website, or a PDF) hosted outside the Gallery.

You can use either option on its own, or combine both in the same Release Note entry.

Accessing the Release Notes Editor

Release Notes are managed from the DevOps Portal of the Extension Gallery.

1. Open the DevOps Portal.
2. Navigate to the Extension whose Release Notes you want to edit.
3. Select the specific Release you want to document.
4. Click Editor to open the Release Notes editor for that release.

Writing Markdown Content

The editor includes a Markdown field where you can document changes for the selected release— for example:

• New features
• Bug fixes
• Breaking changes
• Upgrade or configuration instructions

Standard Markdown formatting is supported, including headings, bullet lists, bold/italic text, and links.

Adding a Documentation Link

Instead of (or in addition to) writing content directly in the editor, you can link to documentation hosted elsewhere — for example, a Documentation article, an internal wiki page, or a customer-facing website.

1. In the Release Notes editor, locate the Links section.
2. Click Add Link.
3. Enter the URL and a descriptive label (e.g., "Full documentation for version 2.3").
4. Repeat to add as many links as needed — there is no limit to the number of links per release.
5. Save your changes.

Important: Links Are Release-Specific

Each Release Note entry is tied to a single Extension release. This means:

• A link added to Release 1 will not automatically appear on Release 2, etc.
• If your documentation applies to multiple releases, you need to add the link again on every relevant release.
• If your documentation itself gets a new URL for a new release, make sure to update the link accordingly on the correct release.

Publishing a Release Note

Adding content to the Release Notes editor is not enough on its own — a Release Note must be explicitly published before it becomes visible to users.

1. Open the Release Notes editor for the relevant release (see Accessing the Release Notes Editor).
2. Tick the Published checkbox.
3. Save your changes.

Best Practices

• Keep Markdown release notes short and scannable — use bullet points rather than long paragraphs.
• Use links for in-depth or long-form documentation (e.g., full user guides), and Markdown for a quick summary of what changed.
• Give linked documentation clear, descriptive labels so users know what to expect before clicking.
• Review and update your release notes as part of your regular release checklist, so this step isn't forgotten for new releases.

FAQ

Can I use both Markdown content and links in the same release?

Yes. They are independent fields and can be combined freely.

Do I need to re-enter my Markdown content for every release?

No — Markdown content is entered separately per release, but you write only what's relevant/new for that specific release(it is not meant to be a cumulative history).

Is there a limit to how many links I can add?

No, you can add as many links as needed per release.