/*!
-\page inside_release Releasing SimGrid
+@page inside_release Releasing SimGrid
-\section inside_release_c Releasing the main library
+@section inside_release_c Releasing the main library
-\subsection inside_release_c_preconditions Before releasing
+@subsection inside_release_c_preconditions Before releasing
Please apply the following checklist before releasing.
- The release date is indicated right below the version name
- The release dub name matches the one given in ChangeLog file
-\subsection inside_release_c_source Building the source archive
+@subsection inside_release_c_source Building the source archive
This should be done from a clean git repository because some files are
included through globbing. The best is to use a clean checkout:
-\verbatim
+@verbatim
cd /tmp
git clone --depth=1 ~/Code/simgrid
cd simgrid
cmake . && make dist
-\endverbatim
+@endverbatim
If you prefer, you can clean your repository the hard way:
-\verbatim
+@verbatim
git reset --hard master # remove all uncommited changes to the files tracked by git
git clean -dfx # delete all files and directories that are not tracked by git
cmake . && make dist
-\endverbatim
+@endverbatim
-\subsection inside_release_c_jarfile Building the binary jarfile
+@subsection inside_release_c_jarfile Building the binary jarfile
Get the jarfiles for several OSes on the CI slaves. Use Save under to
give a separate name to each of them.
-- On Jenkins: Mac OSX, Linux 64 and Linux 32 (without boost-context), FreeBSD
-- On AppVeyor: Windows
-
-For Linux, it is safer to rebuild them in a chroot (to avoid
-boost-context and all other optional dependencies):
-\verbatim
+- Mac OSX, FreeBSD: on Jenkins
+- Windows: on AppVeyor
+- Linux: it is safer to rebuild them in a chroot (to avoid
+ boost-context and all other optional dependencies):
+
+@verbatim
mkdir /tmp/build-amd64
cp SimGrid-3.*.tar.gz /tmp/build-amd64
sudo debootstrap --arch amd64 --variant=buildd testing /tmp/build-amd64 http://deb.debian.org/debian/
sudo chroot /tmp/build-amd64
echo "proc /proc proc rw,nosuid,nodev,noexec,relatime 0 0" >> /tmp/fstab
mount proc /proc -t proc
-apt-get install -y cmake default-jdk libboost-dev python3
+apt-get install -y cmake default-jdk libboost-dev python3 doxygen
cd tmp
tar xfz ../SimGrid*tar.gz && cd SimGrid-*
-cmake . -Denable_documentation=off -Denable_java=ON
-make -j4 && ctest -R java
-\endverbatim
+cmake . -Denable_documentation=ON -Denable_java=ON
+make -j4 && LC_ALL=C ctest -R java
+@endverbatim
Once all jarfiles are in a separate directory, run the following to
merge them:
-\verbatim
+@verbatim
mkdir content ; cd content
-for j in ../simgrid-linux64.jar ../*.jar ; do unzip -n $j ; done
+for j in ../simgrid-linux64.jar ../simgrid*.jar ; do unzip -n $j ; done
# The content of all jar should be the same, but I prefer using the Linux64 version by default
# => unpack it first, and unpack the others with -n (never overwrite)
rm ../simgrid-3_*.jar
zip -r ../simgrid-3_XX.jar * # Produced ../simgrid-3_XX.jar is 7.7M
-\endverbatim
+@endverbatim
To upload the file on gforge, you need to go to Files/Admin then clic
on the Settings icon near to the "Add a version" button, and then on
the settings icon of the release you want to change.
-\subsection inside_release_c_postchecks Check list after releasing
+@subsection inside_release_c_postchecks Check list after releasing
- Tag the git repository (don't forget to push the tags to the main repo)
- Push the archive files (tar.gz and jar) on gforge
- Update the link scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/latest
(and create the directory of the next version)
- Rebuild and resynchronize the website so that the file gets visible
- from our download page.\n
+ from our download page.@n
- Edit org/org-templates/level-0.org to change the release version, the tgz link and the jar link.
- emacs org/site/index.org and C-c C-c the first source block to refresh the news; fake the date in the result.
- emacs org/site/download.org and C-c C-c the first source block to refresh the download.
- Document the tag on https://github.com/simgrid/simgrid/releases
- Mail the simgrid-user mailing list
- the NEWS chunk in the mail;
- - Hall of Fame in the mail\n
+ - Hall of Fame in the mail@n
git shortlog -sne v3.18..
- the ChangeLog chunk as attachment
- Also mail some other lists (G5K users), with only the NEWS chunk
and the link to the download section
- Release the debian package
- - make -C debian/rules get-orig-source
+ - make -f debian/rules get-orig-source
- gbp import ../simgrid_XXX+dfsg.orig.tar.xz
- dch -i "New upstream release" # + copy the NEWS into debian/changelog
- git mv debian/libsimgrid3.XX.install debian/libsimgrid3.XY.install
- libsimgrid3.XY conflicts with libsimgrid3.XX because of smpimain
- Update the simgrid/package.py for spack: https://gitlab.inria.fr/solverstack/spack-repo
- Create the template for the next release in ChangeLog and NEWS files
+ Release Target date: https://en.wikipedia.org/wiki/Equinox
- Change the release number to 3.X.90 in CMakeLists.txt and sonar-project.properties
- Deal with deprecations:
- Introduce the XBT_ATTRIB_DEPRECATED_v??? macro for the next release.