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 COPYING file is aligned with Debian's copyright file, and the
13 dates of SimGrid chunks are accurate.
14 - The version number is correctly marked in CMakeLists.txt, in macros
15 SIMGRID_VERSION_MAJOR and friends.
16 - The "make distcheck" target works (testing that every files needed
17 to build and install are included in the archive)
19 - All tests pass on a reasonable amount of platforms (typically,
20 everything on ci + travis/Mac + AppVeyor)
21 - You also tested to build and install the content of the source
22 archive on a reasonable amount of platforms (typically, 2 or 3).
24 - All changes are documented
25 - The release date is indicated below the changes
26 - The release is marked as stable above the changes (remove the UNRELEASED marker)
27 - The release dub name matches the one given in NEWS file
29 - The most notable changes of the version are documented
30 - The release date is indicated right below the version name
31 - The release dub name matches the one given in ChangeLog file
33 \subsection inside_release_c_source Building the source archive
35 This should be done from a clean git repository because some files are
36 included through globbing. The best is to use a clean checkout:
39 git clone --depth=1 ~/Code/simgrid
44 If you prefer, you can clean your repository the hard way:
46 git reset --hard master # warning, it will kill your uncommited changes
47 git clean -dfx # warning, it will kill your uncommited changes
51 \subsection inside_release_c_jarfile Building the binary jarfile
53 Get the jarfiles for several OSes on the CI slaves. Use Save under to
54 give a separate name to each of them.
56 - On Jenkins: Mac OSX, Linux 64 and Linux 32 (without boost-context), FreeBSD, NetBSD
57 - On AppVeyor: Windows
59 Once all jarfiles are in a separate directory, run the following to
62 mkdir content ; cd content
64 for j in ../simgrid-linux64.jar ../*.jar ; do unzip -n $j ; done
65 # The content of all jar should be the same, but I prefer using the Linux64 version by default
66 # => unpack it first, and unpack the others with -n (never overwrite)
68 test -e doc/javadoc || echo "YOU ARE MISSING THE DOC"
70 du -sh . # 273M here. Let's strip (Darwin is already good)
71 strip NATIVE/*/*/*.so # Gets BSD and Linux versions, down to 116M
72 x86_64-linux-gnu-strip NATIVE/*/*/lib*dll # Gets Windows, down to 22M
75 zip -r ../simgrid-3_XX.jar * # Produced ../simgrid-3_XX.jar is 7.7M
78 To upload the file on gforge, you need to go to Files/Admin then clic
79 on the Settings icon near to the "Add a version" button, and then on
80 the settings icon of the release you want to change.
82 \subsection inside_release_c_postchecks Check list after releasing
84 - Tag the git repository (don't forget to push the tags to the main repo)
85 - Push the archive files (tar.gz and jar) on gforge
86 - Post a news on gforge (before updating the website)
87 - Update the link scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/latest
88 (and create the directory of the next version)
89 - Rebuild and resynchronize the website so that the file gets visible
90 from our download page.\n
91 - Edit org/org-templates/level-0.org to change the release version, the tgz link and the jar link.
92 - emacs org/site/index.org and C-c C-c the first source block to refresh the news; fake the date in the result.
93 - emacs org/site/download.org and C-c C-c the first source block to refresh the download.
94 - emacs org/site/documentation.org and edit the version links.
95 - make -C org all sync
96 - git commit -a && git push
97 - Announce the release
98 - Document the tag on https://github.com/simgrid/simgrid/releases
99 - Mail the simgrid-user mailing list
100 - the NEWS chunk in the mail;
101 - Hall of Fame in the mail\n
102 git shortlog -sne v3.18..
103 - the ChangeLog chunk as attachment
104 - Also mail some other lists (G5K users), with only the NEWS chunk
105 and the link to the download section
106 - Release the debian package
107 - make -C debian/rules get-orig-source
108 - gbp import ../simgrid_XXX+dfsg.orig.tar.xz
109 - dch -i "New upstream release" # + copy the NEWS into debian/changelog
110 - git mv debian/libsimgrid3.XX.install debian/libsimgrid3.XY.install
111 - edit debian/control
112 - s/simgrid3.XX/simgrid3.XY/
113 - libsimgrid3.XY conflicts with libsimgrid3.XX because of smpimain
114 - Update the simgrid/package.py for spack: https://gitlab.inria.fr/solverstack/spack-repo
115 - Create the template for the next release in ChangeLog and NEWS files
116 - Change the release number in CMakeLists.txt and sonar-project.properties
117 - Deal with deprecations:
118 - Introduce the XBT_ATTRIB_DEPRECATED_v??? macro for the next release.
119 - Kill the one for the current release and remove all code that were
120 mandated by the deprecated functions (both in source and headers).
121 - Do the possible cleanups now that these features are gone.