Zephyr 4.1 Release Checklist

[fabiobaltieri]

As soon as possible

• Ensure there is a draft doc/releases/release-notes-4.1.rst and doc/releases/migration-guide-4.1.rst with feature summary from the previous one and if not create one (previous doc: releases: add working draft release notes + guide for v3.7.0 #69418)
• Ensure MAINTAINERS.yml "Release Notes"'s maintainers to point at the current release owners (MAINTAINERS: Update maintainer for release notes #81669)
• Set the current release managers as assignee's in Deprecated APIs/options to be removed by 4.1 #77069 and ensure it is linked from the release plan.

From day one but with extra focus as we approach RC1 and after:

• Check the CI weekly run for build failures that should be fixed and report or fix them.
• Make sure the release plan is kept up to date:
  • See https://github.com/orgs/zephyrproject-rtos/projects/13
• Ensure the release management page has an up-to-date schedule for the release

One month before RC1:

• Ping west project maintainers to remind them of the RC1/freeze deadline and to consider if their modules should be updated (you may want to extract all west projects' maintainers names from the MAINTAINERS files and create an issue like) (previous Zephyr 3.7 Notification to Zephyr west project maintainers & collaborators of freeze #73834)
• Start giving heads ups on the TSC meeting about the incoming freeze.

Two weeks before RC1:

• Send a heads ups about the incoming freeze to dev-mailing list and Discord General channel

Pre RC1

• Create next release (v4.2.0) milestone so that features that don't make it to the release can be assigned a milestone
• Verify that all security-critical external components and external dependencies are up to date
  • (4.0) Zephyr 4.0 security related modules update overview #80489
  • (4.0) Zephyr 4.0 module update overview #80491
  • (4.1) Zephyr 4.1 security related modules update overview #85522
  • (4.1) Zephyr 4.1 module update overview #85523
• Check known vulnerabilities, and fix exploitable vulnerabilities or verify them as un-exploitable (ask Security working group).
• Make sure there's no pending "Release Blocker" issues
• Ensure that the latest Zephyr SDK contains all the changes necessary to support the new features included in, or planned for this release; if not, ping the SDK maintainer (@stephanosio) to release a new SDK version.
  • Check if any toolchain-related enhancements and bug fixes are required for any of the pull requests targeting this release. If any of these enhancements and bug fixes are not part of the latest Zephyr SDK, a new SDK version must be released.
  • Check that the Picolibc version in the latest SDK matches the Picolibc module version in west.yml. If they do not match, a new SDK version must be released. (ping @stephanosio and @keith-packard )
• Create a "Deprecated APIs/options to be removed by x.y" issue for 4.3 (N+3), linking to it from & to the 4.2 one (Deprecated APIs/options to be removed by 4.2 #77070) . Remember to set the deprecation_tracker label.

See https://docs.zephyrproject.org/latest/project/release_process.html#tagging for tagging details, release specific filters under https://github.com/zephyrproject-rtos/zephyr/wiki/Filters to find pending PRs.

• Release Notes and Migration Guide WIP
  • Make sure to tell everybody to
    • Use the past tense (i.e. "X has been added" or "X is now Y")
    • Update doc/releases/release-notes-4.1.rst detailed sections (relative to 3.7.0 release) as important issues are addressed (subsystem owners). (previous: Zephyr 3.3 release notes overview #54495)
  • Be sure to remind maintainers to update the release notes, at the very least in the rc1, rc2 and rc3 emails. But you may need to create a GH issue to follow up.

After RC3, before final release

• Finalize Release Notes and Migration Guide: (previous: Misc clean-up Zephyr 3.7 release notes and migration guide #76113, 3.7 Release notes and migration guide 2nd polish pass #76295 )
  • Review doc/releases/release-notes-4.1.rst overview summary and details sections
    • Request summary details from subsystem maintainers
• Add new version in doc/conf.py, doc/releases/index.rst, and doc/releases/eol_releases.rst (previous release: Zephyr v3.7.0 #76047)
• Remove EOL version(s) in doc/conf.py, doc/releases/index.rst, and doc/releases/eol_releases.rst : (previous: release: Zephyr v3.6.0 #69404) .
• Update doc/LICENSING.rst for new components that do not have a license: (previous: docs: licensing: update list of 3rd party code licensed under GPL #69392)
• Remaining Release Notes (previous 3.7 Release notes - pending areas #75933)
• Update version in VERSION (EXTRAVERSION must be empty, not zero 0) (previous release: Zephyr v3.7.0 #76047 )
• Tag v4.1.0 (see https://docs.zephyrproject.org/latest/project/release_process.html#tagging)
• Update and publish the draft GitHub release created by the CI.
• Tag v4.1.0 in example-application (previous: west: Pin the Zephyr revision to v3.7.0 example-application#73) and create github release from tag.

After Release

• Update patchlevel in VERSION (PATCHLEVEL = 99) (e.g. release: Zephyr v3.7.99 #76334) and tag v4.1.99 (release: Zephyr v4.0.99 #81474)
• Create v4.1-branch branch for 4.1.x releases (from v4.1.0 tag, don't include the switch to patchlevel 99)
• Create backport v4.1-branch label
• Move all PRs/Issues in the v4.1.0 milestone to the next milestone
• Close v4.1.0 milestone
• Email [email protected] & [email protected] 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 / https://www.zephyrproject.org/announcements/)
• Post an update in https://github.com/zephyrproject-rtos/zephyr/discussions under General, have one of our administrators move it to Announcements and pin it.
  • (3.7 Zephyr v3.7.0 released #76336)
  • (4.0: Zephyr 4.0.0 is released! #81499)
• Post an announcement in discord in the #general & #release channels
• Update MAINTAINERS.yml "Release Notes" maintainers to point at the next release owners (MAINTAINERS: Update maintainer for release notes #81669)
• Update current and supported version information in the Security Policy. (github: Update security page for v4.0.0 release #81614)
• If you're a first time release manager, you may contact Tracey (or [email protected]) to claim your Release Manager badge.
• Create draft doc/releases/release-notes-4.1.rst and doc/releases/migration-guide-4.1.rst with feature summary from the previous one (if not there already) doc: releases: add working draft release notes + guide for v4.0.0 #76344

Previous checklist: #76338

[fabled]

@fabiobaltieri Seems you assigned this to me in mistake, no?

[fabiobaltieri]

@fabiobaltieri Seems you assigned this to me in mistake, no?

woops, yes that was meant to go to myself :-) typed "fab" and hit the first one, sorry