2.3 Release Checklist

[jhedberg]

• Major enhancements:

  • See https://github.com/zephyrproject-rtos/zephyr/projects/9

• Pre RC1 Steps

  • Create v2.4.0 milestone so that features that don't make it to the release can be assigned a milestone
  • Verify that all external components and external dependencies are up to date, for example
    • mbedTLS
    • tinycrypt
    • FatFS
  • Check known vulnerabilities, and fix exploitable vulnerabilities or verify them as un-exploitable (Security working group).

See https://docs.zephyrproject.org/latest/development_process/release_process.html#tagging for tagging details

---

• Release Notes WIP
  • Make sure to tell everybody to use the past tense (i.e. "X has been added" or "X is now Y")
  • Create draft doc/releases/release-notes-2.3.rst with feature summary from https://www.zephyrproject.org/developers/#releases-overview doc: releases: Release notes for v2.3 - initial (empty) draft #22923
  • Update doc/releases/release-notes-2.3.rst detailed sections (relative to 2.2.0 release) as important issues are addressed (subsystem owners). See 2.3: Missing release notes #25869

---

• Finalize Release Notes
  • Add list of GitHub issues (spell check issue list and fix in GitHub as needed) using scripts/release/list_issues.py
  • Review doc/releases/release-notes-2.3.rst overview summary and details sections (see Sign-off below)
    • Request summary details from code owners
• update doc/reference/overview.rst
• Update doc/conf.py (add version to pick list)
• Update doc/LICENSING.rst for new components that do not have a license

---

• Final Release Notes Sign-off
  • Subsystems
    • Kernel - @andyross, @andrewboie
    • Build and infrastructure - @tejlmand @nashif @galak
    • Devicetree - @galak, @mbolivar-nordic
    • Drivers and sensors - @MaureenHelm, @tbursztyka, @pabigot, @mnkp
    • Filesystems - @nvlsianpu, @pabigot
    • Networking - @jukkar
    • Bluetooth - @jhedberg , @joerchan, @carlescufi
    • USB - @jfischer-phytec-iot @emob-nordic
    • CAN - @alexanderwachter
  • Architectures
    • ARC - @ruuddw
    • ARM - @ioannisg , @galak, @MaureenHelm
    • X86 - @nashif, @andrewboie
    • RISCV - @pgielda @nategraff-sifive
    • Xtensa, NIOS-II - @nashif, @andrewboie
  • Board an Soc support - many
  • Security - @d3zd3z

---

• Update version in VERSION
• Tag both v2.3.0 and zephyr-v2.3.0
• Create release and add notes on https://github.com/zephyrproject-rtos/zephyr/releases. Make sure you use the zephyr-v2.3.0 tag so that the .zip that GitHub offers has a reasonable name. Add the release notes to the GitHub release.

---

• After Release
  • Update patchlevel in Makefile (PATCHLEVEL = 99)
  • Update doc generation (in future should be automatic based on tag) ping @nashif
  • Update https://www.zephyrproject.org/developer-resources/#current-release (email Brett)
  • Create v2.3-branch branch for 2.3.x releases (from v2.3.0 tag, don't include the switch to patchlevel 99)
  • Merge all post-release PRs in https://github.com/zephyrproject-rtos/zephyr/projects/27
  • Move all PRs/Issues in the 2.3 milestone to the next milestone
  • Close v2.3.0 milestone
  • Email devel@lists.zephyrproject.org & announce@lists.zephyrproject.org lists about release and announce the opening of the merge window
  • Create checklist issue for next release
  • Add a comment to this issue linking to the next release checklist issue
  • Marketing Blog for announcing release (https://www.zephyrproject.org/blog) (email Kate)
  • Update https://www.zephyrproject.org with latest stats from GitHub (email Brett)
  • Update current release dates in https://github.com/zephyrproject-rtos/zephyr/wiki/Program-Management, move current release column to "past releases table", and add next release timeline if missing (v2.6.0)

[carlescufi]

Next release checklist: #26084