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