Release procedure

Overview

This page documents the Release manager responsibilities so that it serves as a knowledge repository for Release managers.

Milestones

The description of the different Milestones leading to a release can be found in the following Program Management sections:

• Milestone definitions
• Planned Milestones

Tagging

Note: This section uses tagging 1.11.0-rc1 as an example, replace with the appropriate version.

Every time a release candidate (or the final release) needs to be tagged, the following steps need to be followed:

1. Update the VERSION file in the root of the Git repository. If it's a release candidate, use EXTRAVERSION:

EXTRAVERSION = rc1

2. Commit the update to the VERSION file, use release: as a commit tag.

3. Tag and push the version, using annotated tags:

$ git tag -a v1.11.0-rc1
<Use "Zephyr 1.11.0-rc1" as the tag annotation>
$ git push [email protected]:zephyrproject-rtos/zephyr.git v1.11.0-rc1

4. Create a shortlog of changes between the previous release:

$ git shortlog v1.10.0..v.1.11.0-rc1

5. Find the new tag at the top of the releases page, edit the release with the "Edit" button and then do the following:

• Name it Zephyr 1.11.0-rc1
• Copy the shortlog into the release notes box (don't forget to quote it properly so it shows as unformatted text in Markdown)
• Check the "This is a pre-release" checkbox if you are tagging a release candidate

6. Send an email to the mailing lists (zephyr-announce and zephyr-devel) with a link to the release