Difference between revisions of "Samba Release Planning"

(General information)
(Patch Process)
 
(16 intermediate revisions by 3 users not shown)
Line 30: Line 30:
 
! style="background:#dfdfdf;" | series !! style="background:#dfdfdf;" | [https://git.samba.org/?p=samba.git;a=heads git branch] !! style="background:#dfdfdf;" | status !! style="background:#dfdfdf;" | started !!style="background:#dfdfdf;" |  maintenance !! style="background:#dfdfdf;" | security !! style="background:#dfdfdf;" | discontinued (EOL)
 
! style="background:#dfdfdf;" | series !! style="background:#dfdfdf;" | [https://git.samba.org/?p=samba.git;a=heads git branch] !! style="background:#dfdfdf;" | status !! style="background:#dfdfdf;" | started !!style="background:#dfdfdf;" |  maintenance !! style="background:#dfdfdf;" | security !! style="background:#dfdfdf;" | discontinued (EOL)
 
|-
 
|-
| 4.8 ([[Release Planning for Samba 4.8|details]]) || [https://git.samba.org/?p=samba.git;a=shortlog;h=refs/heads/v4-8-test v4-8-test] || style="background:#87CEFA;" | [[Samba_Release_Planning#Upcoming_Release|next upcoming release series]] || || || ||
+
| 4.11 ([[Release Planning for Samba 4.11|details]]) || [https://git.samba.org/?p=samba.git;a=shortlog;h=refs/heads/master master] || style="background:#87CEFA;" | [[Samba_Release_Planning#Upcoming_Release|next upcoming release series]] || || || ||
 
|-
 
|-
| 4.7 ([[Release Planning for Samba 4.7|details]]) || [https://git.samba.org/?p=samba.git;a=shortlog;h=refs/heads/v4-7-test v4-7-test] || style="background:#77ff77;" | [[Samba_Release_Planning#Current_Stable_Release|'''current stable release series]] || 2017-09-21 || || ||
+
| 4.10 ([[Release Planning for Samba 4.10|details]]) || [https://git.samba.org/?p=samba.git;a=shortlog;h=refs/heads/v4-10-test v4-10-test] || style="background:#77ff77;" | [[Samba_Release_Planning#Current_Stable_Release|'''current stable release series]] || 2019-03-19 || || ||
 
|-
 
|-
| 4.6 ([[Release Planning for Samba 4.6|details]]) || [https://git.samba.org/?p=samba.git;a=shortlog;h=refs/heads/v4-6-test v4-6-test] || style="background:#77ff77;" | [[Samba_Release_Planning#Maintenance_Mode|'''maintenance mode''']] || 2017-03-07 || 2017-09-21 || ||
+
| 4.9 ([[Release Planning for Samba 4.9|details]]) || [https://git.samba.org/?p=samba.git;a=shortlog;h=refs/heads/v4-9-test v4-9-test] || style="background:#ffff77;" | [[Samba_Release_Planning#Maintenance_Mode|'''maintenance mode]] || 2018-09-13 || 2019-03-19 || ||
 
|-
 
|-
| 4.5 ([[Release Planning for Samba 4.5|details]]) || [https://git.samba.org/?p=samba.git;a=shortlog;h=refs/heads/v4-5-test v4-5-test] || style="background:#ffff77;" | [[Samba_Release_Planning#Security_Fixes_Only_Mode|'''security fixes only''']] || 2016-09-07 || 2017-03-07 || 2017-09-21 ||
+
| 4.8 ([[Release Planning for Samba 4.8|details]]) || [https://git.samba.org/?p=samba.git;a=shortlog;h=refs/heads/v4-8-test v4-8-test] || style="background:#ffff77;" | [[Samba_Release_Planning#Security_Fixes_Only_Mode|''' security fixes only]] || 2018-03-13 || 2018-09-13 || 2019-03-19 ||
 +
|-
 +
| 4.7 ([[Release Planning for Samba 4.7|details]]) || [https://git.samba.org/?p=samba.git;a=shortlog;h=refs/heads/v4-7-test v4-7-test] || style="background:#ff7777;" | [[Samba_Release_Planning#Discontinued_.28End_of_Life.29|'''discontinued (EOL)''']] || 2017-09-21 || 2018-03-13 || 2018-09-13 || 2019-03-19
 +
|-
 +
| 4.6 ([[Release Planning for Samba 4.6|details]]) || [https://git.samba.org/?p=samba.git;a=shortlog;h=refs/heads/v4-6-test v4-6-test] || style="background:#ff7777;" | [[Samba_Release_Planning#Discontinued_.28End_of_Life.29|'''discontinued (EOL)''']] || 2017-03-07 || 2017-09-21 || 2018-03-13 || 2018-09-13
 +
|-
 +
| 4.5 ([[Release Planning for Samba 4.5|details]]) || [https://git.samba.org/?p=samba.git;a=shortlog;h=refs/heads/v4-5-test v4-5-test] || style="background:#ff7777;" | [[Samba_Release_Planning#Discontinued_.28End_of_Life.29|'''discontinued (EOL)''']] || 2016-09-07 || 2017-03-07 || 2017-09-21 || 2018-03-13
 
|-
 
|-
 
| 4.4 ([[Release Planning for Samba 4.4|details]]) || [https://git.samba.org/?p=samba.git;a=shortlog;h=refs/heads/v4-4-test v4-4-test] || style="background:#ff7777;" | [[Samba_Release_Planning#Discontinued_.28End_of_Life.29|'''discontinued (EOL)''']] || 2016-03-22 || 2016-09-07 || 2017-03-07 || 2017-09-21
 
| 4.4 ([[Release Planning for Samba 4.4|details]]) || [https://git.samba.org/?p=samba.git;a=shortlog;h=refs/heads/v4-4-test v4-4-test] || style="background:#ff7777;" | [[Samba_Release_Planning#Discontinued_.28End_of_Life.29|'''discontinued (EOL)''']] || 2016-03-22 || 2016-09-07 || 2017-03-07 || 2017-09-21
Line 95: Line 101:
  
 
Only security issues will be addressed in this release series.
 
Only security issues will be addressed in this release series.
 +
 +
The [[Samba Security Process]] is used in in this and all previous stages to prepare patches and provide them to Samba vendors on an embargoed basis to allow a coordinated release.
  
 
=== Discontinued (End of Life) ===
 
=== Discontinued (End of Life) ===
Line 102: Line 110:
 
== Release Branch Checkin Procedure ==
 
== Release Branch Checkin Procedure ==
  
The '''release branch''' is created at the time of the first '''release candidate.'''
+
The '''release branch''' is created at the time of the first '''release candidate.'''  
  
The release branches are '''closed''' to direct checkin as soon as they are created, so for all branches, only bug fixes are allowed into the branch, according to the following procedure:
+
===Release git branches===
 +
Note there are two different branches:
  
* Every bug that is to be patched in a '''closed branch''' needs to be associated with a bug report in the [https://bugzilla.samba.org Samba Bugzilla].
+
* '''v4.X-stable''': This is the last official release (or release candidate). Use this branch for back-porting security bug-fixes.
 +
* '''v4.X-test''': This is what will eventually become the next official release (excluding security releases). Use this branch for back-porting all other bug-fixes.
 +
 
 +
===Patch Process===
 +
 
 +
The release branches are '''closed''' to direct check-in as soon as they are created, so for all branches, only bug fixes are allowed into the branch, according to the following procedure:
 +
 
 +
* Every bug that is to be patched in a '''release branch''' needs to be associated with a bug report in the [https://bugzilla.samba.org Samba Bugzilla].
 
** If the bug is a '''regression''' that qualifies as [[blocker bugs|blocker bug]] to hold back a major release, ensure it marked as a '''regression''' and has the correct '''milestone''' set.
 
** If the bug is a '''regression''' that qualifies as [[blocker bugs|blocker bug]] to hold back a major release, ensure it marked as a '''regression''' and has the correct '''milestone''' set.
 
* The patch for the bug should already be in [http://git.samba.org/?p=samba.git;a=shortlog master], if possible.   
 
* The patch for the bug should already be in [http://git.samba.org/?p=samba.git;a=shortlog master], if possible.   
Line 113: Line 129:
 
  BUG: <nowiki>https://bugzilla.samba.org/show_bug.cgi?id=XXXXX</nowiki>
 
  BUG: <nowiki>https://bugzilla.samba.org/show_bug.cgi?id=XXXXX</nowiki>
 
* Once '''past autobuild''' and '''in master''' on git.samba.org, it should be cherry-picked from master to the branch using '''git cherry-pick -x''' and '''git format-patch -1'''.
 
* Once '''past autobuild''' and '''in master''' on git.samba.org, it should be cherry-picked from master to the branch using '''git cherry-pick -x''' and '''git format-patch -1'''.
** The cherry-pick -x adds the '''(cherry-picked from XXXXX)''' marker, which allows tracing of patch history though the different branches
+
** The cherry-pick -x adds the '''(cherry picked from commit XXXXX)''' marker, which allows tracing of patch history though the different branches
 
* Add BUG tags to patches that do not already have them
 
* Add BUG tags to patches that do not already have them
 
** The bug should be '''ASSIGNED''', reopen it if the bug is already closed.
 
** The bug should be '''ASSIGNED''', reopen it if the bug is already closed.
 
** It is acceptable to file a bug at this stage if one does not already exist.
 
** It is acceptable to file a bug at this stage if one does not already exist.
* The developer of the patch needs to convince '''two team members''' that the bug is critical enough to be included in a '''closed branch'''.
+
* The developer of the patch needs to convince '''two team members''' that the bug is critical enough to be included in a '''release branch'''.
 
** This is done by setting the '''review?''' flag on the uploaded patch.
 
** This is done by setting the '''review?''' flag on the uploaded patch.
 
** If you are a team member uploading the patch, one other team member needs to review the patch
 
** If you are a team member uploading the patch, one other team member needs to review the patch
Line 124: Line 140:
 
* The '''Release Manager''' then applies the patch from bugzilla only if the patch has been signed off by two members of the Samba Team.
 
* The '''Release Manager''' then applies the patch from bugzilla only if the patch has been signed off by two members of the Samba Team.
 
** The '''Release Manager''' then closes the bug when the patches have landed in all appropriate branches.
 
** The '''Release Manager''' then closes the bug when the patches have landed in all appropriate branches.
 +
 +
===Late patches===
 +
 +
* Please provide patches for release branches early. 
 +
* Patches supplied '''too close''' to the release date '''may not make it in.'''
 +
** Applying patches from bugzilla into a release branch is a manual process, so ''too close'' is entirely at the discretion of the Release Manager.
 +
** Patches without the full review markers etc will not be considered.
 +
* Avoid '''last-moment changes''' to release candidates (the [[Samba_Release_Planning#Upcoming Release|Upcoming Release]]).
 +
** Firstly this goes against the spirit of the name '''release candidate''' if it '''keeps changing'''.
 +
** Too many changes after the final release candidate [https://lists.samba.org/archive/samba-technical/2018-September/130069.html has delayed releases in the past].

Latest revision as of 09:26, 28 May 2019

Samba Release Planning and Supported Release Lifetime

Future Development Roadmap

As each item, and parts of each item on Samba's future development is completed, the features are landed in the master branch, for inclusion in the next stable release of Samba. Development in master is ongoing, in parallel to our stable releases, and new features always land on master first.

General information

The regular Samba release cycle intends a new release series

  • six months fully supported,
  • another six months in the maintenance mode,
  • six months in the security fixes only mode.

In total, each series is maintained for a period of approximately 18 months.

Example:

If 4.5 is the current release series, then 4.4 would be in maintenance mode and 4.3 would be in the security fixes only mode. The support of 4.2 would be stopped with the release of 4.5.0.

Each series can have any number of desired minor releases. These are usually released every 6 weeks (current stable release series), resp. every 9 weeks (maintenance mode).

Any discontinued (EOL) series will not receive any further updates.

series git branch status started maintenance security discontinued (EOL)
4.11 (details) master next upcoming release series
4.10 (details) v4-10-test current stable release series 2019-03-19
4.9 (details) v4-9-test maintenance mode 2018-09-13 2019-03-19
4.8 (details) v4-8-test security fixes only 2018-03-13 2018-09-13 2019-03-19
4.7 (details) v4-7-test discontinued (EOL) 2017-09-21 2018-03-13 2018-09-13 2019-03-19
4.6 (details) v4-6-test discontinued (EOL) 2017-03-07 2017-09-21 2018-03-13 2018-09-13
4.5 (details) v4-5-test discontinued (EOL) 2016-09-07 2017-03-07 2017-09-21 2018-03-13
4.4 (details) v4-4-test discontinued (EOL) 2016-03-22 2016-09-07 2017-03-07 2017-09-21
4.3 (details) v4-3-test discontinued (EOL) 2015-09-08 2016-03-22 2016-09-07 2017-03-07
4.2 (details) v4-2-test discontinued (EOL) 2015-03-04 2015-09-08 2016-03-22 2016-09-07
4.1 (details) v4-1-test discontinued (EOL) 2013-10-11 2015-03-04 2015-09-08 2016-03-22
4.0 (details) v4-0-test discontinued (EOL) 2012-12-11 2013-10-11 2015-03-04 2015-09-08
3.6 (details) v3-6-test discontinued (EOL) 2011-08-09 2012-12-11 2013-11-29 2015-03-04
3.5 (details) v3-5-test discontinued (EOL) 2010-03-01 2011-08-09 ~2012-12-17 2013-10-11
3.4 (details) v3-4-test discontinued (EOL) 2009-07-03 2010-03-01 ~2011-08-23 2012-12-11
3.3 (details) v3-3-test discontinued (EOL) 2009-01-27 2009-07-03 2010-03-01 2011-08-09
3.2 (details) v3-2-test discontinued (EOL) 2008-07-02 2009-01-27 2009-08-11 2010-03-01
3.0 (details) v3-0-test discontinued (EOL) 2003-09-24 2008-07-02 2009-01-27 2009-08-05

Modes

The mode describes the status of the release series. The following modes exist:

  • Upcoming Release
  • Current Stable Release
  • Maintenance Mode
  • Security Fixes Only Mode
  • Discontinued

Upcoming Release

This is the new upcoming release branch. It's not ready for production. The branch is created when the first Release candidate becomes available for testing, otherwise development happens in our master GIT branch.

Blocker bugs and time rather than feature based releases

Releases are made to a time-fixed schedule, so not all bugs found during testing will cause the release to be held back. Blocker bugs are those few that meet the criteria for stopping a release candidate from becoming a release.

Current Stable Release

This is the current release branch. Available bug fixes will be included in the regular bug fix releases. Bug fix releases will be shipped every six weeks usually (and on a as needed basis). New features or parameters will be added to major releases only and not within a release cycle (there might be rare exceptions).

Maintenance Mode

Maintenance mode means that there are regular bug fix releases to address major issues and security issues. Less patches are backported to this branch than to the current release series.

Security Fixes Only Mode

Only security issues will be addressed in this release series.

The Samba Security Process is used in in this and all previous stages to prepare patches and provide them to Samba vendors on an embargoed basis to allow a coordinated release.

Discontinued (End of Life)

There won't be any other versions of this release series.

Release Branch Checkin Procedure

The release branch is created at the time of the first release candidate.

Release git branches

Note there are two different branches:

  • v4.X-stable: This is the last official release (or release candidate). Use this branch for back-porting security bug-fixes.
  • v4.X-test: This is what will eventually become the next official release (excluding security releases). Use this branch for back-porting all other bug-fixes.

Patch Process

The release branches are closed to direct check-in as soon as they are created, so for all branches, only bug fixes are allowed into the branch, according to the following procedure:

  • Every bug that is to be patched in a release branch needs to be associated with a bug report in the Samba Bugzilla.
    • If the bug is a regression that qualifies as blocker bug to hold back a major release, ensure it marked as a regression and has the correct milestone set.
  • The patch for the bug should already be in master, if possible.
  • Open the bug before making the commit into master, if it is expected that this patch will need to be backported.
  • Add the following tag to each patch to be backported
BUG: https://bugzilla.samba.org/show_bug.cgi?id=XXXXX
  • Once past autobuild and in master on git.samba.org, it should be cherry-picked from master to the branch using git cherry-pick -x and git format-patch -1.
    • The cherry-pick -x adds the (cherry picked from commit XXXXX) marker, which allows tracing of patch history though the different branches
  • Add BUG tags to patches that do not already have them
    • The bug should be ASSIGNED, reopen it if the bug is already closed.
    • It is acceptable to file a bug at this stage if one does not already exist.
  • The developer of the patch needs to convince two team members that the bug is critical enough to be included in a release branch.
    • This is done by setting the review? flag on the uploaded patch.
    • If you are a team member uploading the patch, one other team member needs to review the patch
    • If you are not a team member, just ask two team members to review.
  • Once reviewed, the reviewer should assign the patch to Karolin Seeger, our Release Manager.
  • The Release Manager then applies the patch from bugzilla only if the patch has been signed off by two members of the Samba Team.
    • The Release Manager then closes the bug when the patches have landed in all appropriate branches.

Late patches

  • Please provide patches for release branches early.
  • Patches supplied too close to the release date may not make it in.
    • Applying patches from bugzilla into a release branch is a manual process, so too close is entirely at the discretion of the Release Manager.
    • Patches without the full review markers etc will not be considered.
  • Avoid last-moment changes to release candidates (the Upcoming Release).
    • Firstly this goes against the spirit of the name release candidate if it keeps changing.
    • Too many changes after the final release candidate has delayed releases in the past.