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
23 - Release notes in the documentation
24 - The content of the future mail is part of the documentation, since
25 we won't send mails once gforge is definitly turned off.
26 - The date of the release is marked in the title
28 - The "make distcheck" target works (tested by jenkins)
29 - All tests pass on everything on ci + AppVeyor
30 - Tutorials and derivative projects build correctly
31 https://framagit.org/simgrid/simgrid-template-s4u/pipelines
32 https://framagit.org/simgrid/external-projects-ci/pipelines
33 - The python module builds (see below).
34 - The java jarfile builds from the github action
36 @subsection inside_release_c_releasing Actually releasing SimGrid
38 - Update the version number in:
39 - CMakeLists.txt (in macros SIMGRID_VERSION_*)
40 - sonar-project.properties
43 - Commit and push to both framagit and github
44 - Wait for both appveyor and jenkins/osX to complete the build
45 - If it's not successful, fix it and push again
46 - Once it's successful everywhere: merge 'master' into 'stable' and push it to framagit
47 - You can interrupt the build on jenkins, as it was tested just before
48 - This builds the tar.gz artefact.
50 - Download the simgrid-doc-3.X.Y (artefact of pipeline 'pages' on framagit)
51 Download the tgz file (artefact of the pipeline 'stable' on framagit)
52 Build the jar file using the github action
53 - Tag the git repository v3.XX.X and push it to framagit and ghub
54 - Document the tag on framagit and ghub
55 - Upload the files simgrid-3.XX.tar.gz, simgrid-3_XX.jar and simgrid-doc-3_XX.zip
56 - Add a link to the version of the ChangeLog that comes with this tag.
57 https://framagit.org/simgrid/simgrid/-/blob/v3.29/ChangeLog
59 - emacs org/org-templates/level-0.org to change the release version, the tgz link and the jar link.
61 - Change the link to the simgrid-doc-3_XX.zip file
62 - Only keep 2 old versions so that people don't find older ones in google
63 - Change the link to latest
64 - git commit -a && git push # Check that the pipeline goes well on framagit
66 - Rebuild and upload the python package
67 - rm -rf dist/ ; python3 setup.py sdist # Build a source distrib
68 - test that the built distrib recompiles:
69 rm -rf /tmp/pysimgrid && mkdir /tmp/pysimgrid && cp dist/simgrid-*.tar.gz /tmp/pysimgrid
70 (cd /tmp/pysimgrid && tar xfz simgrid*.tar.gz && cd simgrid-*/ && python3 setup.py build)
71 - Upload it to pypi (WARNING: you cannot modify uploaded files, ever)
72 twine upload dist/simgrid-*.tar.gz
74 @subsection inside_release_c_publishing Publishing the release if it's a stable one (3.XX not 3.XX.Y)
76 - Announce the release
77 - Mail the https://sympa.inria.fr/sympa/review/simgrid-community mailing list
78 - the NEWS chunk in the mail;
79 - Hall of Fame in the mail
80 git shortlog -se v3.29..
81 - Link to the ChangeLog on framagit (the version of that tag)
82 - Also mail some other lists (G5K users)
83 - Release the debian package
84 - rm -f ../simgrid_3.*+dfsg.orig.tar.xz
85 - uscan # download the new version
86 - gbp import-orig ../simgrid_3.*+dfsg.orig.tar.xz
87 - dch -i "New upstream release" # + copy the NEWS into debian/changelog
88 - git mv debian/libsimgrid3.XX.install debian/libsimgrid3.XY.install
89 - edit debian/control: s/simgrid3.XX/simgrid3.XY/
90 - Update the simgrid/package.py for spack: https://gitlab.inria.fr/solverstack/spack-repo
91 - Push the stable branch to github to rebuild and push the stable Docker images
92 - It downloads the latest tag on framagit
93 - If it was done automatically at some point, make sure that it's really the latest stable,
94 as things get sometimes out of synch to the point that the github action re-build the previous release.
95 If this happens, just rerun the docker-stable action. Nothing should have been broken.
96 - Doing the same manually: cd tools/docker && make stable && make tuto-s4u tuto-smpi
97 (tuto-mc is not based on simgrid/stable but rebuilds from the git)
98 - Once the new images are built, trigger a rebuild of the simgrid-template-{s4u,smpi} repositories on framagit
99 - Add the new simgrid/stable image to the .gitlab-ci.yml of:
100 - https://framagit.org/simgrid/simgrid-template-s4u/
101 - https://framagit.org/simgrid/simgrid-template-smpi/
103 @subsection inside_release_c_postrelease Post-release cleanups
105 - Create the template for the next release in ChangeLog and NEWS files
106 Release Target date: https://en.wikipedia.org/wiki/Equinox
107 - Bump release number to 3.X.1 in CMakeLists.txt sonar-project.properties docs/source/conf.py setup.py
108 - Deal with deprecations:
109 - jed include/xbt/base.h: Introduce the next XBT_ATTRIB_DEPRECATED_v??? macro
110 - Kill the one for the current release and remove all code that were
111 mandated by the deprecated functions (both in source and headers).
112 - Do the possible cleanups now that these features are gone.
113 - Regenerate the unstable docker with this new version
115 Release numbering semantic:
116 - 3.X is a named release.
117 - We have 4 named releases per year (for each equinox and solstice)
118 - The ChangeLog and NEWS are complete and informative
119 - All tests pass on all ci systems (or the workarounds are documented)
120 - We provide and store a source .tar.gz and a full jarfile on framagit
121 - Deprecated symbols remain usable for at least 3 named releases (~1 year)
122 - These releases are announced to the users
123 - 3.X.Y where Y is even: dot release of 3.X, prerelease of 3.(X+1)
124 - We provide and store a source .tar.gz and a full jarfile on framagit
125 - These releases are NOT announced publicly, nor really documented.
126 The idea is to have something close to a rolling release.
127 - External projects can depend on dot releases to loosen their
128 release process from ours, when 4 release a year is not enough
129 - 3.X.Y where Y is odd: git current status between two releases
130 - No expectations on such versions
132 - 3.22.4: unannounced/loosely documented stable release
133 - 3.22.5: git status somewhere between the release of 3.22.4 and the next one
134 - 3.23: Documented and announced stable release