doc/guides/contributing/stable.rst

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