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 - Tests
  18   - All tests pass on a reasonable amount of platforms (typically,
  19     everything on cdash)
  20   - You also tested to build and install the content of the source
  21     archive on a reasonable amount of platforms (typically, 2 or 3).
  22 - ChangeLog file
  23   - Every changes are documented
  24   - The release date is indicated below the changes
  25   - The release is marked as stable above the changes
  26   - The release dub name matches the one given in NEWS file
  27 - NEWS
  28   - The most notable changes of the version are documented
  29   - The release date is indicated right below the version name
  30   - The release dub name matches the one given in ChangeLog file
  31
  32 \subsection inside_release_c_source Building the source archive
  33
  34 First, clean up your git repository. Some files are included through
  35 globbing, you must ensure that your tree contains no cruft. You can
  36 either checkout a new tree or remove anything from your current tree:
  37 \verbatim
  38 $ cd simgrid
  39 $ git reset --hard master # warning, it will kill your uncommited changes
  40 $ git clean -dfx          # warning, it will kill your uncommited changes
  41 \endverbatim
  42
  43 You can then build the archive. This gives you your archive in the
  44 build dir, named 'SimGrid-${inside_release_version}.tar.gz'.
  45
  46 \verbatim
  47 $ mkdir build
  48 $ cd build
  49 $ cmake ..
  50 $ make dist
  51 \endverbatim
  52
  53 \subsection inside_release_c_win32 Binary distribution under Win32
  54
  55 You have to install nsis tool first. Download it
  56 <a href="http://nsis.sourceforge.net/Download">here</a>.
  57
  58 Then be sure having wget.exe in your path to get the online documentation. You can download it
  59 <a href="http://users.ugent.be/~bpuype/wget/">here</a>.
  60
  61 You can finally make the win installer.
  62 \verbatim
  63 $ cd simgrid
  64 $ mkdir build
  65 $ cd build
  66 $ cmake ..
  67 $ make nsis
  68 \endverbatim
  69
  70 \subsection inside_release_c_postchecks Check list after releasing
  71
  72 - Tag the git repository (don't forget to push the tags to the main
  73   repo)
  74 - Push the archive files on gforge
  75 - Rebuild and resynchronize the website so that the file gets visible
  76   from our download page (see @ref inside_doxygen_website).
  77 - Update the link ff-scm-v4-prod:/home/groups/simgrid/htdocs/simgrid/latest
  78 - Announce the release
  79  - Mail the simgrid-user mailing list
  80     - the NEWS chunk in the mail;
  81     - the ChangeLog chunk as attachment
  82  - Also mail some other lists (G5K users), with only the NEWS chunk
  83    and the link to the download section
  84
  85 \section inside_release_bindings Releasing the bindings
  86
  87 Please apply the above checklists before and after releasing the bindings.
  88
  89 Then, clean your git repository and build the archive. It will give
  90 you an archive file in the build dir:
  91 'SimGrid-Ruby-${inside_release_version}.tar.gz'.
  92
  93 \verbatim
  94 $ cd simgrid-ruby
  95 $ git reset --hard master
  96 $ git clean -dfx
  97 $ mkdir build
  98 $ cd build
  99 $ cmake ..
 100 $ make dist
 101 \endverbatim
 102
 103 */