doc/guides/contributing/stable.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2018 The DPDK contributors
   3
   4 .. stable_lts_releases:
   5
   6 DPDK Stable Releases and Long Term Support
   7 ==========================================
   8
   9 This section sets out the guidelines for the DPDK Stable Releases and the DPDK
  10 Long Term Support releases (LTS).
  11
  12
  13 Introduction
  14 ------------
  15
  16 The purpose of the DPDK Stable Releases is to maintain releases of DPDK with
  17 backported fixes over an extended period of time. This provides downstream
  18 consumers of DPDK with a stable target on which to base applications or
  19 packages.
  20
  21 The Long Term Support release (LTS) is a designation applied to a Stable
  22 Release to indicate longer term support.
  23
  24
  25 Stable Releases
  26 ---------------
  27
  28 Any major release of DPDK can be designated as a Stable Release if a
  29 maintainer volunteers to maintain it.
  30
  31 A Stable Release is used to backport fixes from an ``N`` release back to an
  32 ``N-1`` release, for example, from 16.11 to 16.07.
  33
  34 The duration of a stable is one complete release cycle (3 months). It can be
  35 longer, up to 1 year, if a maintainer continues to support the stable branch,
  36 or if users supply backported fixes, however the explicit commitment should be
  37 for one release cycle.
  38
  39 The release cadence is determined by the maintainer based on the number of
  40 bugfixes and the criticality of the bugs. Releases should be coordinated with
  41 the validation engineers to ensure that a tagged release has been tested.
  42
  43
  44 LTS Release
  45 -----------
  46
  47 A stable release can be designated as an LTS release based on community
  48 agreement and a commitment from a maintainer. The current policy is that each
  49 year's November release will be maintained as an LTS for 2 years.
  50
  51 The current DPDK LTS releases are 16.11 and 17.11.
  52
  53 It is anticipated that there will be at least 4 releases per year of the LTS
  54 or approximately 1 every 3 months. However, the cadence can be shorter or
  55 longer depending on the number and criticality of the backported
  56 fixes. Releases should be coordinated with the validation engineers to ensure
  57 that a tagged release has been tested.
  58
  59
  60 What changes should be backported
  61 ---------------------------------
  62
  63 Backporting should be limited to bug fixes. All patches accepted on the master
  64 branch with a Fixes: tag should be backported to the relevant stable/LTS
  65 branches, unless the submitter indicates otherwise. If there are exceptions,
  66 they will be discussed on the mailing lists.
  67
  68 Fixes suitable for backport should have a ``Cc: stable@dpdk.org`` tag in the
  69 commit message body as follows::
  70
  71      doc: fix some parameter description
  72
  73      Update the docs, fixing description of some parameter.
  74
  75      Fixes: abcdefgh1234 ("doc: add some parameter")
  76      Cc: stable@dpdk.org
  77
  78      Signed-off-by: Alex Smith <alex.smith@example.com>
  79
  80
  81 Fixes not suitable for backport should not include the ``Cc: stable@dpdk.org`` tag.
  82
  83 Features should not be backported to stable releases. It may be acceptable, in
  84 limited cases, to back port features for the LTS release where:
  85
  86 * There is a justifiable use case (for example a new PMD).
  87 * The change is non-invasive.
  88 * The work of preparing the backport is done by the proposer.
  89 * There is support within the community.
  90
  91
  92 The Stable Mailing List
  93 -----------------------
  94
  95 The Stable and LTS release are coordinated on the stable@dpdk.org mailing
  96 list.
  97
  98 All fix patches to the master branch that are candidates for backporting
  99 should also be CCed to the `stable@dpdk.org <http://dpdk.org/ml/listinfo/stable>`_
 100 mailing list.
 101
 102
 103 Releasing
 104 ---------
 105
 106 A Stable Release will be released by:
 107
 108 * Tagging the release with YY.MM.n (year, month, number).
 109 * Uploading a tarball of the release to dpdk.org.
 110 * Sending an announcement to the `announce@dpdk.org <http://dpdk.org/ml/listinfo/announce>`_
 111   list.
 112
 113 Stable releases are available on the `dpdk.org download page <http://dpdk.org/download>`_.
 114
 115
 116 ABI
 117 ---
 118
 119 The Stable Release should not be seen as a way of breaking or circumventing
 120 the DPDK ABI policy.