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