Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
3cbc5eb3777b6843b3709c00b896fc7dfcc83c65
[simgrid.git] / 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 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_*), and also in sonar-project.properties
16   - The "make distcheck" target works (testing that every files needed
17     to build and install are included in the archive)
18 - Tests
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).
23 - ChangeLog file
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
28 - NEWS
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
32
33 @subsection inside_release_c_source Building the source archive
34
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:
37 @verbatim
38 cd /tmp
39 git clone --depth=1 ~/Code/simgrid
40 cd simgrid
41 cmake . && make dist
42 @endverbatim
43
44 If you prefer, you can clean your repository the hard way:
45 @verbatim
46 git reset --hard master # remove all uncommited changes to the files tracked by git
47 git clean -dfx          # delete all files and directories that are not tracked by git
48 cmake . && make dist
49 @endverbatim
50
51 @subsection inside_release_c_jarfile Building the binary jarfile
52
53 Get the jarfiles for several OSes on the CI slaves. Use Save under to
54 give a separate name to each of them.
55
56 - Mac OSX, FreeBSD: on Jenkins
57 - Windows: on AppVeyor
58 - Linux: it is safer to rebuild them in a chroot (to avoid
59   boost-context and all other optional dependencies):
60   
61 @verbatim
62 mkdir /tmp/build-amd64
63 cp SimGrid-3.*.tar.gz /tmp/build-amd64
64 sudo debootstrap --arch amd64 --variant=buildd testing /tmp/build-amd64 http://deb.debian.org/debian/
65 sudo chroot /tmp/build-amd64
66 echo "proc /proc proc rw,nosuid,nodev,noexec,relatime 0 0" >> /tmp/fstab
67 mount proc /proc -t proc
68 apt-get install -y cmake default-jdk libboost-dev python3 doxygen
69 cd tmp
70 tar xfz ../SimGrid*tar.gz && cd SimGrid-*
71 cmake . -Denable_documentation=ON -Denable_java=ON
72 make -j4 && LC_ALL=C ctest -R java
73 @endverbatim
74
75 Once all jarfiles are in a separate directory, run the following to
76 merge them:
77 @verbatim
78 mkdir content ; cd content
79
80 for j in  ../simgrid-linux64.jar ../simgrid*.jar ; do unzip -n $j ; done
81 # The content of all jar should be the same, but I prefer using the Linux64 version by default
82 #  => unpack it first, and unpack the others with -n (never overwrite)
83
84 test -e doc/javadoc || echo "YOU ARE MISSING THE DOC"
85
86 du -sh .                                  # 273M here. Let's strip (Darwin is already good)
87 strip NATIVE/*/*/*.so                     # Gets BSD and Linux versions, down to 116M
88 x86_64-linux-gnu-strip NATIVE/*/*/lib*dll # Gets Windows, down to 22M
89
90 rm ../simgrid-3_*.jar
91 zip -r ../simgrid-3_XX.jar *              # Produced ../simgrid-3_XX.jar is 7.7M
92 @endverbatim
93
94 To upload the file on gforge, you need to go to Files/Admin then clic
95 on the Settings icon near to the "Add a version" button, and then on
96 the settings icon of the release you want to change.
97
98 @subsection inside_release_c_postchecks Check list after releasing
99
100 - Tag the git repository (don't forget to push the tags to the main repo)
101 - Push the archive files (tar.gz and jar) on gforge
102 - Post a news on gforge (before updating the website)
103 - Update the link scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/latest
104   (and create the directory of the next version)
105 - Rebuild and resynchronize the website so that the file gets visible
106   from our download page.@n
107   - Edit org/org-templates/level-0.org to change the release version, the tgz link and the jar link.
108   - emacs org/site/index.org and C-c C-c the first source block to refresh the news; fake the date in the result.
109   - emacs org/site/download.org and C-c C-c the first source block to refresh the download.
110   - emacs org/site/documentation.org and edit the version links.
111   - make -C org all sync
112   - git commit -a && git push
113 - Announce the release
114  - Document the tag on https://github.com/simgrid/simgrid/releases
115  - Mail the simgrid-user mailing list
116     - the NEWS chunk in the mail;
117     - Hall of Fame in the mail@n
118       git shortlog -sne v3.18..
119     - the ChangeLog chunk as attachment
120  - Also mail some other lists (G5K users), with only the NEWS chunk
121    and the link to the download section
122 - Release the debian package
123   - make -f debian/rules get-orig-source
124   - gbp import ../simgrid_XXX+dfsg.orig.tar.xz
125   - dch -i "New upstream release" # + copy the NEWS into debian/changelog
126   - git mv debian/libsimgrid3.XX.install debian/libsimgrid3.XY.install
127   - edit debian/control
128     - s/simgrid3.XX/simgrid3.XY/ 
129     - libsimgrid3.XY conflicts with libsimgrid3.XX because of smpimain
130 - Update the simgrid/package.py for spack: https://gitlab.inria.fr/solverstack/spack-repo
131 - Create the template for the next release in ChangeLog and NEWS files
132   Release Target date: https://en.wikipedia.org/wiki/Equinox
133 - Change the release number to 3.X.90 in CMakeLists.txt and sonar-project.properties
134 - Deal with deprecations:
135   - Introduce the XBT_ATTRIB_DEPRECATED_v??? macro for the next release.
136   - Kill the one for the current release and remove all code that were
137     mandated by the deprecated functions (both in source and headers).
138   - Do the possible cleanups now that these features are gone.
139
140 */