doc/doxygen/inside_release.doc

   1 /*!
   2 \page inside_release Releasing SimGrid
   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.
  13   - The "make distcheck" target works (testing that every files needed
  14     to build and install are included in the archive)
  15 - Tests
  16   - All tests pass on a reasonable amount of platforms (typically,
  17     everything on ci)
  18   - You also tested to build and install the content of the source
  19     archive on a reasonable amount of platforms (typically, 2 or 3).
  20 - ChangeLog file
  21   - All changes are documented
  22   - The release date is indicated below the changes
  23   - The release is marked as stable above the changes
  24   - The release dub name matches the one given in NEWS file
  25 - NEWS
  26   - The most notable changes of the version are documented
  27   - The release date is indicated right below the version name
  28   - The release dub name matches the one given in ChangeLog file
  29
  30 \subsection inside_release_c_source Building the source archive
  31
  32 First, clean up your git repository. Some files are included through
  33 globbing, you must ensure that your tree contains no cruft. You can
  34 either checkout a new tree or remove anything from your current tree:
  35 \verbatim
  36 $ cd simgrid
  37 $ git reset --hard master # warning, it will kill your uncommited changes
  38 $ git clean -dfx          # warning, it will kill your uncommited changes
  39 \endverbatim
  40
  41 You can then build the archive. This gives you your archive in the
  42 build dir, named 'SimGrid-${inside_release_version}.tar.gz'.
  43
  44 \verbatim
  45 $ mkdir build
  46 $ cd build
  47 $ cmake ..
  48 $ make dist
  49 \endverbatim
  50
  51 \subsection inside_release_c_postchecks Check list after releasing
  52
  53 - Tag the git repository (don't forget to push the tags to the main repo)
  54 - Push the archive files on gforge
  55 - Rebuild and resynchronize the website so that the file gets visible
  56   from our download page (see @ref inside_doxygen_website).
  57 - Update the link scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/latest
  58 - Announce the release
  59  - Mail the simgrid-user mailing list
  60     - the NEWS chunk in the mail;
  61     - the ChangeLog chunk as attachment
  62  - Also mail some other lists (G5K users), with only the NEWS chunk
  63    and the link to the download section
  64  - Post a news on gforge
  65
  66 */