2 \page inside_release SimGrid Developer Guide - Releasing
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. 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).
22 - All tests pass on a reasonable amount of platforms (typically,
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).
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
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
36 \subsection inside_release_c_source Building the source archive
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:
43 $ git reset --hard master # warning, it will kill your uncommited changes
44 $ git clean -dfx # warning, it will kill your uncommited changes
47 You can then build the archive. This gives you your archive in the
48 build dir, named 'SimGrid-${inside_release_version}.tar.gz'.
57 \subsection inside_release_c_win32 Binary distribution under Win32
59 You have to install nsis tool first. Download it
60 <a href="http://nsis.sourceforge.net/Download">here</a>.
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>.
65 You can finally make the win installer.
74 \subsection inside_release_c_postchecks Check list after releasing
76 - Tag the git repository (don't forget to push the tags to the main
78 - Push the archive files on gforge
79 - Rebuild and resynchronize the website so that the file gets visible
80 from our download page (see @ref inside_doxygen_website).
81 - Update the link ff-scm-v4-prod:/home/groups/simgrid/htdocs/simgrid/latest
82 - Announce the release
83 - Mail the simgrid-user mailing list
84 - the NEWS chunk in the mail;
85 - the ChangeLog chunk as attachment
86 - Also mail some other lists (G5K users), with only the NEWS chunk
87 and the link to the download section
89 \section inside_release_bindings Releasing the bindings
91 Please apply the above checklists before and after releasing the bindings.
93 Then, clean your git repository and build the archive. It will give
94 you an archive file in the build dir:
95 'SimGrid-Java-${inside_release_version}.tar.gz' or
96 'SimGrid-Ruby-${inside_release_version}.tar.gz'.
99 $ cd simgrid-java (or simgrid-ruby)
100 $ git reset --hard master