doc/doxygen/inside_release.doc

   1 /*!
   2 \page inside_release SimGrid Developer Guide - Releasing
   3
   4 \section inside_release_c Releasing the main library
   5
   6 \subsection inside_release_c_preconditions Before releasing
   7
   8 Please apply the following checklist before releasing.
   9
  10 - Sources
  11   - The version number is correctly marked in CMakeList.txt, in macros
  12     SIMGRID_VERSION_MAJOR and friends. Please also update the
  13     comments right before these macros so that we keep a track of the
  14     version numbers that were used.
  15   - The" make distcheck" target works (testing that every files needed
  16     to build and install are included in the archive)
  17   - The version number provided to download in the examples of
  18     doc/doxygen/install.doc is accurate (we should maybe generate this
  19     file to avoid issues, but some inaccuracies are less painful than
  20     editing the cmake files to make this happen, sorry).
  21 - Tests
  22   - All tests pass on a reasonable amount of platforms (typically,
  23     everything on cdash)
  24   - You also tested to build and install the content of the source
  25     archive on a reasonable amount of platforms (typically, 2 or 3).
  26 - ChangeLog file
  27   - Every changes are documented
  28   - The release date is indicated below the changes
  29   - The release is marked as stable above the changes
  30   - The release dub name matches the one given in NEWS file
  31 - NEWS
  32   - The most notable changes of the version are documented
  33   - The release date is indicated right below the version name
  34   - The release dub name matches the one given in ChangeLog file
  35
  36 \subsection inside_release_c_source Building the source archive
  37
  38 First, clean up your git repository. Some files are included through
  39 globbing, you must ensure that your tree contains no cruft. You can
  40 either checkout a new tree or remove anything from your current tree:
  41 \verbatim
  42 $ cd simgrid
  43 $ git reset --hard master # warning, it will kill your uncommited changes
  44 $ git clean -dfx          # warning, it will kill your uncommited changes
  45 \endverbatim
  46
  47 You can then build the archive. This gives you your archive in the
  48 build dir, named 'SimGrid-${inside_release_version}.tar.gz'.
  49
  50 \verbatim
  51 $ mkdir build
  52 $ cd build
  53 $ cmake ..
  54 $ make dist
  55 \endverbatim
  56
  57 \subsection inside_release_c_win32 Binary distribution under Win32
  58
  59 You have to install nsis tool first. Download it
  60 <a href="http://nsis.sourceforge.net/Download">here</a>.
  61
  62 Then be sure having wget.exe in your path to get the online documentation. You can download it
  63 <a href="http://users.ugent.be/~bpuype/wget/">here</a>.
  64
  65 You can finally make the win installer.
  66 \verbatim
  67 $ cd simgrid
  68 $ mkdir build
  69 $ cd build
  70 $ cmake ..
  71 $ make nsis
  72 \endverbatim
  73
  74 \subsection inside_release_c_postchecks Check list after releasing
  75
  76 - Tag the git repository (don't forget to push the tags to the main
  77   repo)
  78 - Push the archive files on gforge
  79 - Update the link ff-scm-v4-prod:/home/groups/simgrid/htdocs/simgrid/latest
  80 - Announce the release
  81  - Mail the simgrid-user mailing list
  82     - the NEWS chunk in the mail;
  83     - the ChangeLog chunk as attachment
  84  - Also mail some other lists (G5K users), with only the NEWS chunk
  85    and the link to the download section
  86
  87 \section inside_release_bindings Releasing the bindings
  88
  89 Please apply the above checklists before and after releasing the bindings.
  90
  91 Then, clean your git repository and build the archive. It will give
  92 you an archive file in the build dir:
  93 'SimGrid-Java-${inside_release_version}.tar.gz' or
  94 'SimGrid-Ruby-${inside_release_version}.tar.gz'.
  95
  96 \verbatim
  97 $ cd simgrid-java (or simgrid-ruby)
  98 $ git reset --hard master
  99 $ git clean -dfx
 100 $ mkdir build
 101 $ cd build
 102 $ cmake ..
 103 $ make dist
 104 \endverbatim
 105
 106 */