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
  15     - CMakeLists.txt (in macros SIMGRID_VERSION_*)
  16     - sonar-project.properties
  17     - docs/source/conf.py
  18     - setup.py
  19 - Tests
  20   - The "make distcheck" target works (tested by jenkins)
  21   - All tests pass oneverything on ci + travis/macOS + AppVeyor
  22   - Tutorials and derivative projects build correctly
  23     https://framagit.org/simgrid/simgrid-template-s4u/pipelines
  24     https://framagit.org/simgrid/external-projects-ci/pipelines
  25   - The python module builds (see below).
  26 - ChangeLog file
  27   - All changes are documented
  28   - The release date is indicated below the changes
  29   - The release is marked as stable above the changes (remove the UNRELEASED marker)
  30   - The release dub name matches the one given in NEWS file
  31 - NEWS
  32   - The most notable changes of the version are documented
  33   - The release date is indicated right below the version name
  34   - The release dub name matches the one given in ChangeLog file
  35
  36 @subsection inside_release_c_source Building the source archive
  37
  38 This should be done from a clean git repository because some files are
  39 included through globbing. The best is to use a clean checkout:
  40 @verbatim
  41 cd /tmp
  42 git clone --depth=1 ~/Code/simgrid
  43 cd simgrid
  44 cmake . && make dist
  45 @endverbatim
  46
  47 If you prefer, you can clean your repository the hard way:
  48 @verbatim
  49 git reset --hard master # remove all uncommited changes to the files tracked by git
  50 git clean -dfx          # delete all files and directories that are not tracked by git
  51 cmake . && make dist
  52 @endverbatim
  53
  54 @subsection inside_release_c_jarfile Building the binary jarfile
  55
  56 Get the jarfiles for several OSes on the CI slaves. Use Save under to
  57 give a separate name to each of them.
  58
  59 - macOS, FreeBSD: on Jenkins
  60 - Windows: on AppVeyor
  61 - Linux: it is safer to rebuild them in a chroot (to avoid
  62   boost-context and all other optional dependencies):
  63
  64 @verbatim
  65 mkdir /tmp/build-amd64
  66 cp SimGrid-3.*.tar.gz /tmp/build-amd64
  67 sudo debootstrap --arch amd64 --variant=buildd testing /tmp/build-amd64 http://deb.debian.org/debian/
  68 sudo chroot /tmp/build-amd64
  69 echo "proc /proc proc rw,nosuid,nodev,noexec,relatime 0 0" >> /tmp/fstab
  70 mount proc /proc -t proc
  71 apt-get install -y cmake default-jdk libboost-dev python3 doxygen
  72 cd tmp
  73 tar xfz ../SimGrid*tar.gz && cd SimGrid-*
  74 cmake . -Denable_documentation=ON -Denable_java=ON
  75 make -j4 && LC_ALL=C ctest -R java
  76 @endverbatim
  77
  78 Once all jarfiles are in a separate directory, run the following to
  79 merge them:
  80 @verbatim
  81 mkdir content ; cd content
  82
  83 for j in  ../simgrid-linux64.jar ../simgrid*.jar ; do unzip -n $j ; done
  84 # The content of all jar should be the same, but I prefer using the Linux64 version by default
  85 #  => unpack it first, and unpack the others with -n (never overwrite)
  86
  87 test -e doc/javadoc || echo "YOU ARE MISSING THE DOC"
  88
  89 du -sh .                                  # 273M here. Let's strip (Darwin is already good)
  90 strip NATIVE/*/*/*.so                     # Gets BSD and Linux versions, down to 116M
  91 x86_64-linux-gnu-strip NATIVE/*/*/lib*dll # Gets Windows, down to 22M
  92
  93 rm ../simgrid-3_*.jar
  94 zip -r ../simgrid-3_XX.jar *              # Produced ../simgrid-3_XX.jar is 7.7M
  95 @endverbatim
  96
  97 To upload the file on gforge, you need to go to Files/Admin then clic
  98 on the Settings icon near to the "Add a version" button, and then on
  99 the settings icon of the release you want to change.
 100
 101 @subsection inside_release_c_postchecks Check list after releasing
 102
 103 - Tag the git repository (don't forget to push the tags to the main repo)
 104 - Push the archive files (tar.gz and jar) on gforge
 105 - #Post a news on gforge (before updating the website)
 106 - Document the tag on https://github.com/simgrid/simgrid/releases and
 107   on https://framagit.org/simgrid/simgrid/tags
 108   - Upload the files SimGrid-3.XX.tar.gz, simgrid-3_XX.jar and
 109     SimGrid-doc-3_XX.zip (that is the artefact of the pages job on framagit) files to the changelog.
 110 - Update the website
 111   - Edit org/org-templates/level-0.org to change the release version, the tgz link and the jar link.
 112   - emacs org/site/index.org and C-c C-c the first source block to refresh the news; fake the date in the result.
 113   - emacs org/site/download.org and C-c C-c the first source block to refresh the download.
 114   - emacs org/site/documentation.org and edit the version links.
 115   - make -C org all sync
 116   - jed .gitlab-ci.yml
 117     - Change the link to the SimGrid-doc-3_XX.zip file
 118     - Only keep 2 versions so that people don't find older ones in google
 119     - Change the link to latest
 120   - git commit -a && git push
 121 - Announce the release
 122  - Mail the simgrid-user mailing list
 123     - the NEWS chunk in the mail;
 124     - Hall of Fame in the mail
 125       git shortlog -se v3.21..
 126     - Link to the ChangeLog on framagit (the version of that tag)
 127  - Also mail some other lists (G5K users)
 128 - Release the debian package
 129   - rm -f ../simgrid_3.*+dfsg.orig.tar.xz
 130   - uscan # download the new version
 131   - gbp import-orig ../simgrid_3.*+dfsg.orig.tar.xz
 132   - dch -i "New upstream release" # + copy the NEWS into debian/changelog
 133   - git mv debian/libsimgrid3.XX.install debian/libsimgrid3.XY.install
 134   - edit debian/control: s/simgrid3.XX/simgrid3.XY/
 135 - Update the simgrid/package.py for spack: https://gitlab.inria.fr/solverstack/spack-repo
 136 - Create the template for the next release in ChangeLog and NEWS files
 137   Release Target date: https://en.wikipedia.org/wiki/Equinox
 138 - Bump release number to 3.X.1 in CMakeLists.txt sonar-project.properties docs/source/conf.py setup.py
 139 - Deal with deprecations:
 140   - jed include/xbt/base.h: Introduce the next XBT_ATTRIB_DEPRECATED_v??? macro
 141   - Kill the one for the current release and remove all code that were
 142     mandated by the deprecated functions (both in source and headers).
 143   - Do the possible cleanups now that these features are gone.
 144 - Update the Docker images (after pushing to the git)
 145   - cd tools/docker && make stable tuto-s4u tuto-smpi push
 146   - Update the simgrid-template-s4u repository to test against this new release
 147     jed ~/Code/simgrid-template-s4u/.gitlab-ci.yml
 148
 149 Release numbering semantic:
 150   - 3.X is a named release.
 151     - We have 4 named releases per year (for each equinox and solstice)
 152     - The ChangeLog and NEWS are complete and informative
 153     - All tests pass on all ci systems (or the workarounds are documented)
 154     - We provide and store a source .tar.gz and a full jarfile on framagit
 155     - Deprecated symbols remain usable for at least 3 named releases (~1 year)
 156     - These releases are announced to the users
 157   - 3.X.Y where Y is even: dot release of 3.X, prerelease of 3.(X+1)
 158     - We provide and store a source .tar.gz and a full jarfile on framagit
 159     - These releases are NOT announced publicly, nor really documented.
 160       The idea is to have something close to a rolling release.
 161     - External projects can depend on dot releases to loosen their
 162       release process from ours, when 4 release a year is not enough
 163   - 3.X.Y where Y is odd: git current status between two releases
 164     - No expectations on such versions
 165   - Example
 166     - 3.22.4: unannounced/losely documented stable release
 167     - 3.22.5: git status somewhere between the release of 3.22.4 and the next one
 168     - 3.23: Documented and announced stable release
 169
 170 Doing a dot release:
 171   - Update the version number in:
 172       - CMakeLists.txt (in macros SIMGRID_VERSION_*)
 173       - sonar-project.properties
 174       - docs/source/conf.py
 175       - setup.py
 176   - Commit and push to both framagit and github
 177   - Wait for both appveyor and jenkins/highsierra to complete the build
 178   - If it's not successful, fix it and push again
 179   - Once it's successful on both appveyor and jenkins:
 180     - Build the source tar.gz
 181     - Build the jarfile
 182     - Download the simgrid-doc-3.X.Y from the pages pipeline on framagit
 183     - tag the release v3.X.Y and push the tag
 184     - Merge 'master' into 'stable' and push it to framagit
 185       - Do not merge into 'stable' before appveyor and jenkins are done,
 186         or your jarfile will not contain the code you expect for win and
 187         mac.
 188     - Edit the tag on github and framagit
 189   - Rebuild and upload the python package
 190     - rm -rf dist/ ; python3 setup.py sdist # Build a source distrib
 191     - test that the built distrib recompiles:
 192       rm -rf /tmp/pysimgrid && mkdir /tmp/pysimgrid && cp dist/simgrid-*.tar.gz /tmp/pysimgrid
 193       (cd /tmp/pysimgrid && tar xfz simgrid*.tar.gz && cd simgrid-*/ && python3 setup.py build)
 194     - Upload it to pypi (WARNING: you cannot modify uploaded files, ever)
 195       twine upload dist/simgrid-*.tar.gz
 196
 197 */