doc/user_manual/release_cycle.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %
   3 %    NEPI, a framework to manage network experiments
   4 %    Copyright (C) 2013 INRIA
   5 %
   6 %    This program is free software: you can redistribute it and/or modify
   7 %    it under the terms of the GNU General Public License as published by
   8 %    the Free Software Foundation, either version 3 of the License, or
   9 %    (at your option) any later version.
  10 %
  11 %    This program is distributed in the hope that it will be useful,
  12 %    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 %    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 %    GNU General Public License for more details.
  15 %
  16 %    You should have received a copy of the GNU General Public License
  17 %    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 %
  19 % Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  20 %
  21 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  22
  23 Releases in NEPI do not occur in strictly regular periods. Usually a new
  24 release will be done every 4 or 5 months.
  25
  26 \section{The development branch}
  27
  28 The main development branch for NEPI 3 is \emph{nepi-3-dev}.
  29 There might be other branches to develop new features, but they will
  30 eventually end up being merged into the \emph{nepi-3-dev} branch.
  31
  32 \section{Versioning}
  33
  34 Releases are named following the \emph{major.minor.revision} convention.
  35 The \emph{major} number reflects a major change in functionality or architecture.
  36 It is to be expected that this number will remind in 3 for a long period.
  37
  38 The \emph{minor} number reflects the incorporation of new features into NEPI.
  39 This number is expected to be increased on each release.
  40
  41 The \emph{revision} number is incremented when a considerable number of
  42 bugs have been fixed. No release will be done when only the \emph{revision}
  43 number is incremented.
  44
  45 \section{The release process}
  46
  47 The creation of a new NEPI release will always follow the same sequence of steps.
  48
  49 \begin{enumerate}
  50   \item A new \emph{nepi-3.<minor>-pre-release} branch will be created from the \emph{nepi-3-dev} branch
  51   \item During two to three weeks intensive work on testing will be carried out on the new branch. No new functionality will be added on this branch and only changes that fix bugs will be accepted.
  52   \item At the end of this period, the pre-release branch will be branched again into the release branch, named \emph{nepi-3.<minor>-release}
  53   \item A tag will be added to this new branch including the revision number (i.e. \emph{release-3.<minor>.<revision>})
  54   \item Finally, the pre-release branch will be merged into the development branch, nepi-3-dev, to incorporate to it all the bug fixes.
  55 \end{enumerate}
  56
  57 %%TODO: Explain how to create patch
  58