Bug 10888

Summary: Add documentation about releases and release process
Product: [Documentation] General Docs Reporter: Richard Purdie <richard.purdie>
Component: docs-generalAssignee: Scott Rifenbark <srifenbark>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: Medium+ CC: akuster, joshuagloe, srifenbark
Version: unspecified   
Target Milestone: 2.3 M4   
Hardware: x86   
OS: Multiple   
Whiteboard: 16 Mar 2017: RESOLVED
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)
Bug Depends on:    
Bug Blocks: 9037    

Description Richard Purdie 2017-01-06 15:50:21 UTC
I propose we add a section to the manual along the lines of:

"""
Releases and the Stable Release Process

The Yocto Project deliveres releases on a six month cadence with releases roughly in April and October. There is never a perfect cadance but this timescale has been found to mean we release (and hence have a strong QA cycle) regularly enough that the project quality is maintained but not so often users are overwhelemed with new releases, its a predictable cycle which can be relied upon and it avoids as many major holidays in various geos as we can.

Each release is given a codename which is used to indentify it in the repositories. The idea is that branches of metadata with the same codename are likely to work together. The reason a codename is used is that version numbers often conflict with a given layer's or company's own versioning scheme and the codenames are chosen to be fairly identifiable. The releases are given a nominal release version too but the codename is used in repositories for this reason. Information about the releases and codenames can be found on https://wiki.yoctoproject.org/wiki/Releases

After being released, the release enters the stable release process. A stable release maintainer is appointed for the release and this person then looks after their given stable release and people can nominate patches to be backported. Only things which have first been fixed on master (the current indevelopment branch) can be considered for backporting to the stable release. Our policy is to only consider backporting bug fixes and fixes for security issues, not features. This means generic recipe version upgrades are unlikely to be accepted, unless there is a strong reason like the version upgrade is the upstream preferred approach to security fixes and features are not backported.

The stable releases are periodically released as point releases (e.g. 2.2.1, the first point release of 2.2), this indicate point where we go through a full QA cycle and release process which validates the content of the release branch. There may be patches merged onto the stable release branches as and when they become available however.

The convention is for the stable release branches to have strong maintainship and releases for around a year after their original release. For significant issues, we may backport things to older releases. Beyond this point there is are communuty-lts trees and branches where people share patchs for older releases but these do not go through the same release process as the point releases. https://wiki.yoctoproject.org/wiki/Stable_branch_maintenance has more information about stable branches.
"""

pieces in this last paragraph are about to be discussed with the community so might change if there are alternative proposals/suggestions.
Comment 1 Scott Rifenbark 2017-01-10 22:04:25 UTC
Accepting and setting up some development parameters for person days and target milestone.
Comment 2 Scott Rifenbark 2017-03-13 19:16:57 UTC
Richard, 

See http://www.yoctoproject.org/docs/2.3/ref-manual/ref-manual.html#ref-release-process for the new chapter I inserted in the ref-manual.  Quite a bit of re-writing and organization.  Let me know what you think.

Thanks, 
Scott
Comment 3 Armin Kuster 2017-03-16 05:48:06 UTC
(In reply to comment #2)
> Richard, 
> 
> See
> http://www.yoctoproject.org/docs/2.3/ref-manual/ref-manual.html#ref-release-
> process for the new chapter I inserted in the ref-manual.  Quite a bit of
> re-writing and organization.  Let me know what you think.
> 
> Thanks, 
> Scott

Scott,

Very nice. thanks for doing this.

- Armin
Comment 4 Scott Rifenbark 2017-03-16 16:25:44 UTC
Thanks Armin, 

I will ping Richard and see if he signs off on the new chapter or wants to tweak some things. 

Scott
Comment 5 Scott Rifenbark 2017-03-16 16:45:53 UTC
I spoke with Richard and with the addition of some major YP release names as examples in the first section, he is good with the new information.  It is here - http://www.yoctoproject.org/docs/2.3/ref-manual/ref-manual.html#ref-release-process.   I am setting the bug's status to RESOLVED and marking the doc flag to "done."

Thanks, 
Scott