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