Skip to content

Latest commit

 

History

History
 
 

release-notes

README.md

Radius release notes

This directory contains the release notes for each Radius release. The release notes are written in Markdown and are included as the body of each Radius release.

Release process

Refer to the release process docs for more information on how to create a new release.

Release notes format

Each release note is a Markdown file named vX.Y.Z.md where X.Y.Z is the semantic version of the release (e.g. v0.21.0.md).

Refer to template.md for the template to use when creating a new release note.

Versions

The template contains a few places where the placeholder version, X.Y.Z, needs to be updated. This version is determined by the release process, documented in the release contribution docs.

Check for the following comment, placed directly under any reference to the placeholder version. After updating the version make sure to delete the comment.

<!-- REMINDER TO UPDATE THE VERSION ABOVE AND DELETE THIS COMMENT -->

Highlights

While the full changelog and release notes contain every PR and commit that went into the release, the highlights section is a curated list of the most important changes in the release. This section should be written in a way that is easy for users to understand and digest. Talk to a PM if you need help determining what to include in the highlights section, and how to phrase it.

Generating the full changelog (release notes) and new contributors

Within the template is the ## Full changelog section, which is a complete list of commits merged since the last release.

To generate the release notes:

  1. Visit Generate a new release in the radius repository.
    • Note that you will not be creating the release through the UI, just generating the list of merged PRs. This could be automated in the future using the GitHub API
  2. Dropdown the Choose a tag menu and manually enter the tag for the upcoming release (e.g. v0.21.0). Keep Target as 'main'.
  3. Dropdown the Previous tag menu and select the tag for the previous minor release (e.g. v0.20.0). Don't select patch or RC releases.
  4. Click Generate release notes to generate the markdown for the release notes.
  5. Copy both the contents of ## What's Changed and ## New Contributors into their respective sections in the template (make sure not to copy the headers, as they already exist in the template).
  6. Exit out of the window without publishing the release or saving a draft.

Patch releases

Patch releases will be uploaded to Github Releases and require patch release notes for the release workflow to execute. The patch release notes follow the same formatting as the original release notes, but only contain info about the changelog.

Refer to template_patch.md for the template to use when creating a new patch release note.