2 @page inside_release Releasing SimGrid
4 @section inside_release_c Releasing the main library
6 @subsection inside_release_c_preconditions Before releasing
8 Please apply the following checklist before releasing.
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.
15 - All changes are documented
16 - The release date is indicated below the changes
17 - The release is marked as stable above the changes (remove the UNRELEASED marker)
18 - The release dub name matches the one given in NEWS file
20 - The most notable changes of the version are documented
21 - The release date is indicated right below the version name
22 - The release dub name matches the one given in ChangeLog file
24 - The "make distcheck" target works (tested by jenkins)
25 - All tests pass oneverything on ci + travis/macOS + AppVeyor
26 - Tutorials and derivative projects build correctly
27 https://framagit.org/simgrid/simgrid-template-s4u/pipelines
28 https://framagit.org/simgrid/external-projects-ci/pipelines
29 - The python module builds (see below).
30 - You can have a simgrid.jar from jenkins/macosx + AppVeyor
32 @subsection inside_release_c_releasing Actually releasing SimGrid
34 - Update the version number in:
35 - CMakeLists.txt (in macros SIMGRID_VERSION_*)
36 - sonar-project.properties
39 - Commit and push to both framagit and github
40 - Wait for both appveyor and jenkins/osX to complete the build
41 - If it's not successful, fix it and push again
42 - Once it's successful everywhere: merge 'master' into 'stable' and push it to framagit
43 - You can interrupt the build on jenkins, as it was tested just before
44 - This builds the tar.gz and jar artefacts. The old doc says how to do manually if something goes wrong.
45 - Do not merge into 'stable' before appveyor and jenkins are done,
46 or your jarfile will not contain the code you expect for win and mac.
48 - Download the simgrid-doc-3.X.Y (artefact of pipeline 'pages' on framagit)
49 Download the tgz and jar files (artefacts of the pipeline 'stable' on framagit)
50 - Push the archive files (tar.gz and jar) on gforge
51 - Tag the git repository v3.XX.X and push it to framagit and ghub
52 - Document the tag on framagit and ghub
53 - Upload the files simgrid-3.XX.tar.gz, simgrid-3_XX.jar and simgrid-doc-3_XX.zip
54 - Add a link to the version of the ChangeLog that comes with this tag.
56 - emacs org/org-templates/level-0.org to change the release version, the tgz link and the jar link.
58 - Change the link to the simgrid-doc-3_XX.zip file
59 - Only keep 2 versions so that people don't find older ones in google
60 - Change the link to latest
61 - git commit -a && git push # Check that the pipeline goes well on framagit
63 - Rebuild and upload the python package
64 - rm -rf dist/ ; python3 setup.py sdist # Build a source distrib
65 - test that the built distrib recompiles:
66 rm -rf /tmp/pysimgrid && mkdir /tmp/pysimgrid && cp dist/simgrid-*.tar.gz /tmp/pysimgrid
67 (cd /tmp/pysimgrid && tar xfz simgrid*.tar.gz && cd simgrid-*/ && python3 setup.py build)
68 - Upload it to pypi (WARNING: you cannot modify uploaded files, ever)
69 twine upload dist/simgrid-*.tar.gz
71 @subsection inside_release_c_publishing Publishing the release if it's a stable one (3.XX not 3.XX.Y)
73 - Announce the release
74 - Mail the simgrid-user mailing list
75 - the NEWS chunk in the mail;
76 - Hall of Fame in the mail
77 git shortlog -se v3.24..
78 - Link to the ChangeLog on framagit (the version of that tag)
79 - Also mail some other lists (G5K users)
80 - Release the debian package
81 - rm -f ../simgrid_3.*+dfsg.orig.tar.xz
82 - uscan # download the new version
83 - gbp import-orig ../simgrid_3.*+dfsg.orig.tar.xz
84 - dch -i "New upstream release" # + copy the NEWS into debian/changelog
85 - git mv debian/libsimgrid3.XX.install debian/libsimgrid3.XY.install
86 - edit debian/control: s/simgrid3.XX/simgrid3.XY/
87 - Update the simgrid/package.py for spack: https://gitlab.inria.fr/solverstack/spack-repo
88 - Update the Docker images (after pushing to the git)
89 - cd tools/docker && make stable.
90 The argument passing is somehow failing, so you'll need to copy/paste + execute manually this line:
91 docker build -f Dockerfile.stable --build-arg DLURL=????? -t simgrid/stable:latest ...........
92 - Upload the stable docker image once built
93 - Once the new image is uploaded, trigger a rebuild of the images tuto-{s4u,smpi} on https://hub.docker.com
94 They use the dockerfiles in simgrid:tools/docker, and are built upon the simgrid/stable image
95 - Once the new images are built, trigger a rebuild of the simgrid-template-{s4u,smpi} repositories on framagit
97 @subsection inside_release_c_postrelease Post-release cleanups
99 - Create the template for the next release in ChangeLog and NEWS files
100 Release Target date: https://en.wikipedia.org/wiki/Equinox
101 - Bump release number to 3.X.1 in CMakeLists.txt sonar-project.properties docs/source/conf.py setup.py
102 - Deal with deprecations:
103 - jed include/xbt/base.h: Introduce the next XBT_ATTRIB_DEPRECATED_v??? macro
104 - Kill the one for the current release and remove all code that were
105 mandated by the deprecated functions (both in source and headers).
106 - Do the possible cleanups now that these features are gone.
108 Release numbering semantic:
109 - 3.X is a named release.
110 - We have 4 named releases per year (for each equinox and solstice)
111 - The ChangeLog and NEWS are complete and informative
112 - All tests pass on all ci systems (or the workarounds are documented)
113 - We provide and store a source .tar.gz and a full jarfile on framagit
114 - Deprecated symbols remain usable for at least 3 named releases (~1 year)
115 - These releases are announced to the users
116 - 3.X.Y where Y is even: dot release of 3.X, prerelease of 3.(X+1)
117 - We provide and store a source .tar.gz and a full jarfile on framagit
118 - These releases are NOT announced publicly, nor really documented.
119 The idea is to have something close to a rolling release.
120 - External projects can depend on dot releases to loosen their
121 release process from ours, when 4 release a year is not enough
122 - 3.X.Y where Y is odd: git current status between two releases
123 - No expectations on such versions
125 - 3.22.4: unannounced/loosely documented stable release
126 - 3.22.5: git status somewhere between the release of 3.22.4 and the next one
127 - 3.23: Documented and announced stable release