Yocto Project Release Process
Yocto Linux Release Engineering Procedures
This document describes release engineering procedures for the Yocto Linux project.
Yocto Project Naming Conventions
Official/public releases will use the following scheme: M.m.p
- M = major release number
- m = minor release number
- p = minor rev release number (aka "point" or "patch" release)
Major release number changes imply compatibility changes with previous releases. Minor release number changes imply significant changes up to, but not including compatibility changes. Minor rev number changes are for minor issues such as simple bugfixes, security updates, etc.
Nightly releases will be named using the following scheme: image-name-M.m.p-date-buildnum.extension, where M.m.p is the release number, where date is the datestamp of the build, e.g, 20100715, and buildnum is a build counter, e.g, 1, 2, 3, in case more than one build is generated the same day.
Milestone releases will be named using the following scheme: image-name-M.m.p-date-milestonenum-buildnum.extension, where the field definitions are the same as above with the addition of milestonenum, e.g. M3.
Our first public release was 0.9.0 in October 2010. Our second public release will be the 1.0.0 release in Spring 2011.
Yocto Project Releases
Yocto Project releases are known by their Major.Minor.patch number. For example:
The main download directory utilizes this naming convention.
Poky is the reference distro the Yocto Project releases with each Yocto Project release. These releases are named releases (danny, dora, dylan, edison, etc.) as well as numbered utilizing Major.minor.patch numbering.
Yocto Project/Poky Releases, while they do not share the same numbering, are released at the same time. This includes point releases. So, for example, the 1.4.1 Yocto Project point release, was used to build the dylan-9.0.1 poky point release.
|Yocto Project Release||Poky Release Name||Poky Release|
A full listing of releases, code names, Poky and BitBake versions and other related info may be found here:
Types of Releases
Nightly releases can be considered a "base class" of the release system. Weekly releases are generated directly from them, and otherwise the nightly release build status serves as a fundamental health status of the builds. Nightly releases are built directly from poky master and failures should be immediately addressed or the offending changes reverted.
Internal/QA Weekly Releases
These releases are the basic unit of internal progress for the Yocto project.
Every Wednesday (mid-day US Pacific time), the nightly build will generate a release which gets submitted to QA that evening (the start of China's Thursday).
If this weekly release passes initial testing from QA, the QA team will continue on to run their full weekly test suite.
If the weekly release does not pass initial testing from QA, the QA team will report this to the distro team and the distro team will focus on addressing these issues the next day. If the distro team lead believes these changes will resolve the reported issues, he/she will submit the nightly build for that day to QA again.
Weekly releases will be made available to the QA team via a web-accessible directory on the autobuilder. Within this directory, a tarball of all of the above components will be available to make downloading the release more convenient.
These releases are performed at the end of a milestone period and are used to measure our progress in delivering new features to Yocto Linux.
To generate a milestone release, we generate a release candidate from master. After each release candidate has cleared QA, the branch is tagged (M.m_M1).
The milestone is copied to the release area preserving links and then cleaned up. We remove rpm/deb directories and then remove .gz files in machines (except for p1022), bz2 files (except for p1022) and then all ext3 files for everything except qemu machines.
Point releases/Major Releases
These are the final, QA-tested, manager-approved releases of Yocto Linux which will WOW our customers and change the future of embedded Linux devices. Words can barely describe the awesomeness of these SDK and filesystem images!
Yocto Linux includes a number of software components to be included in each release. These include:
- Bootable QEMU images of minimal and sato for the following architectures: qemux86, qemux86-64, qemuarm, qemumips, qemuppc
- A bootable QEMU image consists of a kernel file, a kernel modules tarball, and root filesystem tarball
- Non-emulated machine targets (e.g, netbook, emenlow) will include appropriate images (e.g, live images) of minimal and sato.
- meta-toolchain tarballs for the following host/target combinations: i586/[arm|i586|mips|ppc|x86_64], x86_64/[arm|i586|mips|ppc|x86_64]
- Bootable SDK images for the following architectures: qemux86, qemux86-64, qemuarm, qemumips, qemuppc
- SDK plugins for the following IDEs: Anjuta, Eclipse
Currently the SDK plugins are not being generated with the remaining build output. Jessica and Scott will need to define a process for this that makes sense before public release. There are issues to be take into consideration such as how the plugins are distributed (Anjuta and Eclipse have their own plugin repositories, for example).
- named git archives - a file with each git archived named with the hash of the git commit used the images were built from
- adt repository - A repository of all ipk packages used to build the images (Deprecated as of the 2.0 release. Newer releases now have eSDK instead.)
- RELEASENOTES - a gpg signed file with all bugfixes, added features and git hash info for a release
- *.md5sums - md5sum files of all files within the release
Major/Point Release Procedures
Release Readiness Review
The Release Readiness Review is a sign-off process for official/public Yocto releases. This process reviews feature completeness, status of open defects, testing status, and verifies the status of documentation. From the release readiness review a decision is made on the status of launching an official release.
Technical Release Procedures
24 hours before the release is made public, the release images would be mirrored to external locations and allow time for the blog and mailing list announcements to be written. The final steps in releasing would be ready to be performed in a matter of seconds:
- Move the release directory from a staging area into the public web server area
- Push the web site update including new release information
- Post the pre-written release announcement on the blog and mailing lists
Release Process for the Yocto Project
Prior to last milestone
- Release Engineer gets release name from Richard Purdie and announces it via email@example.com
- Release Engineer informs Documentation of the new release names so that they have time to modify documentation
During the last milestone we generally will build from master and then branch when things are at the point where they're mostly stable. We do this to reduce the amount of work required to maintain two branches. Once we're seeing good daily builds and feel confident enough to branch, we will branch the poky, meta-qt3 and eclipse repos to a branch named after the name of the release (dora, dylan, laverne, etc).
Prior to release build
- If the build is a point release, use the appropriate release branch (edison, bernard, etc). If not, create a milestone release branch in the following repositories. The milestone branch follows <Major>.<minor>_M<milestone_number> where Major and minor are Yocto release Major and minor release numbers.
- Set DISTRO and DISTRO_VERSION in meta/conf/poky.conf
- Update handbook references to stable release (introduction.xml, master branch needs this too)
- Update version reference and updated date in handbook (poky-handbook.xml)
- Run the nightly build using the release branch from the autobuilder. This will create images at http://autobuilder.yoctoproject.org/pub/nightly/<datestamp>/.
- If the build is "good", and adequate for delivery to QA, git tag/sign/commit the above repo's release branch HEADs as <Major>.<minor>_M<milestone_number>.rc<release_candidate_number>
- Update MIRRORS to use the autobuilders source dir
Release of Build
- Run the release script to stage the release. http://git.yoctoproject.org/cgit/cgit.cgi/yocto-autobuilder/tree/bin/release_scripts/release.py. This script will do the following...
- Create the staging directory. - Remove the rpm/deb directories. - Delete duplicate files and extraneous blobs, and convert symlinks. - Rename tarballs to reflect current naming conventions. For example. poky-<githash>.tar.bz2 should be renamed to poky-<release_name>-<release_number>.tar.bz2 - Generate the BSP tarballs - Extract the eclipse-plugin archive to http://downloads.yoctoproject.org/releases/eclipse-plugin/<M>.<m> where M.m is the Yocto version - Copy the adt-dev repo to the live site (For release lines prior to 2.0.) - Create the md5sum table for the release
- Copy the staging directory to the downloads directory
- gpg sign the md5sum table
- Create release notes, finalize, get approval, and gpg sign.
- Create the release and BSP pages on yoctoproject.org
- Create the documentation links for the release on yoctoproject.org
- Sync the release out to the mirrors.
- Once sync out is complete, verify that pages work, and download and documentation links work.
- Tag the repos.
- Verify the items on the RELEASE CHECKLIST: https://wiki.yoctoproject.org/wiki/Yocto_Project_Release_Checklist
- Post release announcement on Blog
- Post release announcement on mailing lists (yocto and yocto-announce)
- Update DISTRO and DISTRO_VERSION in master to be the main release+snapshot