2 \page inside_release Releasing SimGrid
4 \section inside_release_c Releasing the main library
6 \subsection inside_release_c_preconditions Before releasing
8 Please apply the following checklist before releasing.
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)
16 - All tests pass on a reasonable amount of platforms (typically,
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).
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
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
30 \subsection inside_release_c_source Building the source archive
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:
37 $ git reset --hard master # warning, it will kill your uncommited changes
38 $ git clean -dfx # warning, it will kill your uncommited changes
41 You can then build the archive. This gives you your archive in the
42 build dir, named 'SimGrid-${inside_release_version}.tar.gz'.
51 \subsection inside_release_c_postchecks Check list after releasing
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