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 external patches (Debian, etc) are integrated.
12 - The version number is correctly marked in CMakeLists.txt, in macros
13 SIMGRID_VERSION_MAJOR and friends.
14 - The "make distcheck" target works (testing that every files needed
15 to build and install are included in the archive)
17 - All tests pass on a reasonable amount of platforms (typically,
19 - You also tested to build and install the content of the source
20 archive on a reasonable amount of platforms (typically, 2 or 3).
22 - All changes are documented
23 - The release date is indicated below the changes
24 - The release is marked as stable above the changes (remove the UNRELEASED marker)
25 - The release dub name matches the one given in NEWS file
27 - The most notable changes of the version are documented
28 - The release date is indicated right below the version name
29 - The release dub name matches the one given in ChangeLog file
31 \subsection inside_release_c_source Building the source archive
33 This should be done from a clean git repository because some files are
34 included through globbing. The best is to use a clean checkout:
37 git clone --depth=1 ~/Code/simgrid
42 If you prefer, you can clean your repository the hard way:
44 git reset --hard master # warning, it will kill your uncommited changes
45 git clean -dfx # warning, it will kill your uncommited changes
49 \subsection inside_release_c_source Building the binary jarfile
51 Get the jarfiles for several OSes on the CI slaves. Use Save under to
52 give a separate name to each of them.
54 - On Jenkins: Mac OSX, Linux 64 and Linux 32 (without boost-context), FreeBSD, NetBSD
55 - On AppVeyor: Windows
57 Once all jarfiles are in a separate directory, run the following to
60 mkdir content ; cd content
62 for j in ../simgrid-linux64.jar ../*.jar ; do unzip -n $j ; done
63 # The content of all jar should be the same, but I prefer using the Linux64 version by default
64 # => unpack it first, and unpack the others with -n (never overwrite)
66 test -e doc/javadoc || echo "YOU ARE MISSING THE DOC"
68 du -sh . # 273M here. Let's strip (Darwin is already good)
69 strip NATIVE/*/*/*.so # Gets BSD and Linux versions, down to 116M
70 x86_64-linux-gnu-strip NATIVE/*/*/lib*dll # Gets Windows, down to 22M
73 zip -r ../simgrid-3_XX.jar * # Produced ../simgrid-3_XX.jar is 7.7M
76 To upload the file on gforge, you need to go to Files/Admin then clic
77 on the Settings icon near to the "Add a version" button, and then on
78 the settings icon of the release you want to change.
80 \subsection inside_release_c_postchecks Check list after releasing
82 - Tag the git repository (don't forget to push the tags to the main repo)
83 - Push the archive files (tar.gz and jar) on gforge
84 - Post a news on gforge (before updating the website)
85 - Update the link scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/latest
86 (and create the directory of the next version)
87 - Rebuild and resynchronize the website so that the file gets visible
88 from our download page.\n
89 - Edit org/org-templates/level-0.org to change the release version, the tgz link and the jar link.
90 - emacs org/site/index.org and C-c C-c the first source block to refresh the news.
91 - emacs org/site/download.org and C-c C-c the first source block to refresh the download.
92 - emacs org/site/documentation.org and edit the version links.
93 - make -C org all sync
94 - git commit -a && git push
95 - Announce the release
96 - Mail the simgrid-user mailing list
97 - the NEWS chunk in the mail;
98 - the ChangeLog chunk as attachment
99 - Also mail some other lists (G5K users), with only the NEWS chunk
100 and the link to the download section
101 - Release the debian package
102 - Create the template for the next release in ChangeLog and NEWS files
103 - Change the release number in CMakeLists.txt