/*!
-\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 external patches (Debian, etc) are integrated.
The COPYING file is aligned with Debian's copyright file, and the
dates of SimGrid chunks are accurate.
- - The version number is correctly marked in CMakeLists.txt (in macros
- SIMGRID_VERSION_*), and also in sonar-project.properties
+ - The version number is correctly marked in
+ - CMakeLists.txt (in macros SIMGRID_VERSION_*)
+ - sonar-project.properties
+ - docs/source/conf.py
- The "make distcheck" target works (testing that every files needed
to build and install are included in the archive)
- Tests
- 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.
- Linux: it is safer to rebuild them in a chroot (to avoid
boost-context and all other optional dependencies):
-\verbatim
+@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/
tar xfz ../SimGrid*tar.gz && cd SimGrid-*
cmake . -Denable_documentation=ON -Denable_java=ON
make -j4 && LC_ALL=C ctest -R java
-\endverbatim
+@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 ../simgrid*.jar ; do unzip -n $j ; done
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
- Post a news on gforge (before updating the website)
- Update the link scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/latest
- (and create the directory of the next version)
+ - Create the directory of the released version and upload the doc artefact in it
+ - Remove the older releases so that people don't find them in google
- 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.
- make -C org all sync
- git commit -a && git push
- Announce the release
- - Document the tag on https://github.com/simgrid/simgrid/releases
+ - Document the tag on https://github.com/simgrid/simgrid/releases and
+ on https://framagit.org/simgrid/simgrid/tags
- Mail the simgrid-user mailing list
- the NEWS chunk in the mail;
- - 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
+ - Hall of Fame in the mail@n
+ git shortlog -se v3.21..
+ - Link to the ChangeLog on framagit (the version of that tag)
+ - Also mail some other lists (G5K users)
- Release the debian package
- - make -f debian/rules get-orig-source
- - gbp import ../simgrid_XXX+dfsg.orig.tar.xz
+ - rm -f ../simgrid_3.*+dfsg.orig.tar.xz
+ - uscan # download the new version
+ - gbp import-orig ../simgrid_3.*+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
- - edit debian/control
- - s/simgrid3.XX/simgrid3.XY/
- - libsimgrid3.XY conflicts with libsimgrid3.XX because of smpimain
+ - edit debian/control: s/simgrid3.XX/simgrid3.XY/
- 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
+- Change the release number to 3.X.90 in CMakeLists.txt and sonar-project.properties docs/source/conf.py
- Deal with deprecations:
- Introduce the XBT_ATTRIB_DEPRECATED_v??? macro for the next release.
- Kill the one for the current release and remove all code that were
mandated by the deprecated functions (both in source and headers).
- Do the possible cleanups now that these features are gone.
+- Update the Docker images (after pushing to the git)
+ - cd tools/docker && make stable tuto-s4u push
*/
