- ChangeLog file
- All changes are documented
- The release date is indicated below the changes
- - The release is marked as stable above the changes (remove the UNRELEASED marker)
- The release dub name matches the one given in NEWS file
- NEWS
- The most notable changes of the version are documented
- Release notes in the documentation
- The content of the future mail is part of the documentation, since
we won't send mails once gforge is definitly turned off.
+ - The date of the release is marked in the title
- Tests
- The "make distcheck" target works (tested by jenkins)
- - All tests pass on everything on ci + AppVeyor
+ - All tests pass on everything on ci
- Tutorials and derivative projects build correctly
https://framagit.org/simgrid/simgrid-template-s4u/pipelines
https://framagit.org/simgrid/external-projects-ci/pipelines
- The python module builds (see below).
- - The java jarfile builds from the github action
@subsection inside_release_c_releasing Actually releasing SimGrid
- Update the version number in:
+ - ChangeLog header
- CMakeLists.txt (in macros SIMGRID_VERSION_*)
- sonar-project.properties
- docs/source/conf.py
- setup.py
- Commit and push to both framagit and github
-- Wait for both appveyor and jenkins/osX to complete the build
+- Wait for jenkins/osX to complete the build
- If it's not successful, fix it and push again
- Once it's successful everywhere: merge 'master' into 'stable' and push it to framagit
- You can interrupt the build on jenkins, as it was tested just before
- Download the simgrid-doc-3.X.Y (artefact of pipeline 'pages' on framagit)
Download the tgz file (artefact of the pipeline 'stable' on framagit)
- Build the jar file using the github action
- Tag the git repository v3.XX.X and push it to framagit and ghub
- Document the tag on framagit and ghub
- - Upload the files simgrid-3.XX.tar.gz, simgrid-3_XX.jar and simgrid-doc-3_XX.zip
+ - Upload the files simgrid-3.XX.tar.gz and simgrid-doc-3_XX.zip
- Add a link to the version of the ChangeLog that comes with this tag.
https://framagit.org/simgrid/simgrid/-/blob/v3.29/ChangeLog
- Update the website
- - emacs org/org-templates/level-0.org to change the release version, the tgz link and the jar link.
+ - emacs org/org-templates/level-0.org to change the release version and the tgz link.
- jed .gitlab-ci.yml
- Change the link to the simgrid-doc-3_XX.zip file
- Only keep 2 old versions so that people don't find older ones in google
@subsection inside_release_c_publishing Publishing the release if it's a stable one (3.XX not 3.XX.Y)
- Announce the release
- - Mail the simgrid-user mailing list
+ - Mail the https://sympa.inria.fr/sympa/review/simgrid-community mailing list
- the NEWS chunk in the mail;
- Hall of Fame in the mail
- git shortlog -se v3.24..
+ git shortlog -se v3.29..
- Link to the ChangeLog on framagit (the version of that tag)
- Also mail some other lists (G5K users)
- Release the debian package
- git mv debian/libsimgrid3.XX.install debian/libsimgrid3.XY.install
- edit debian/control: s/simgrid3.XX/simgrid3.XY/
- Update the simgrid/package.py for spack: https://gitlab.inria.fr/solverstack/spack-repo
-- Update the Docker images (after pushing to the git)
- - cd tools/docker && make stable && make tuto-s4u tuto-smpi tuto-mc
- The tuto images are built upon the simgrid/stable image
- - Upload these docker images once built
+- Push the stable branch to github to rebuild and push the stable Docker images
+ - It downloads the latest tag on framagit
+ - If it was done automatically at some point, make sure that it's really the latest stable,
+ as things get sometimes out of synch to the point that the github action re-build the previous release.
+ If this happens, just rerun the docker-stable action. Nothing should have been broken.
+ - Doing the same manually: cd tools/docker && make stable && make tuto-s4u tuto-smpi
+ (tuto-mc is not based on simgrid/stable but rebuilds from the git)
- Once the new images are built, trigger a rebuild of the simgrid-template-{s4u,smpi} repositories on framagit
+- Add the new simgrid/stable image to the .gitlab-ci.yml of:
+ - https://framagit.org/simgrid/simgrid-template-s4u/
+ - https://framagit.org/simgrid/simgrid-template-smpi/
@subsection inside_release_c_postrelease Post-release cleanups
- Kill the one for the current release and remove all code that were
mandated by the deprecated functions (both in source and headers).
- Do the possible cleanups now that these features are gone.
+- Regenerate the unstable docker with this new version
Release numbering semantic:
- 3.X is a named release.
- We have 4 named releases per year (for each equinox and solstice)
- The ChangeLog and NEWS are complete and informative
- All tests pass on all ci systems (or the workarounds are documented)
- - We provide and store a source .tar.gz and a full jarfile on framagit
+ - We provide and store a source .tar.gz on framagit
- Deprecated symbols remain usable for at least 3 named releases (~1 year)
- These releases are announced to the users
- 3.X.Y where Y is even: dot release of 3.X, prerelease of 3.(X+1)
- - We provide and store a source .tar.gz and a full jarfile on framagit
+ - We provide and store a source .tar.gz on framagit
- These releases are NOT announced publicly, nor really documented.
The idea is to have something close to a rolling release.
- External projects can depend on dot releases to loosen their
