to build and install are included in the archive)
- Tests
- All tests pass on a reasonable amount of platforms (typically,
- everything on ci + travis/Mac + AppVeyor)
+ everything on ci + travis/macOS + AppVeyor)
- You also tested to build and install the content of the source
archive on a reasonable amount of platforms (typically, 2 or 3).
- ChangeLog file
Get the jarfiles for several OSes on the CI slaves. Use Save under to
give a separate name to each of them.
-- Mac OSX, FreeBSD: on Jenkins
+- macOS, FreeBSD: on Jenkins
- Windows: on AppVeyor
- Linux: it is safer to rebuild them in a chroot (to avoid
boost-context and all other optional dependencies):
- Tag the git repository (don't forget to push the tags to the main repo)
- Push the archive files (tar.gz and jar) on gforge
- Post a news on gforge (before updating the website)
-- Update the link scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/latest
- - Create the directory of the released version and upload the doc artefact in it
- - Remove the older releases so that people don't find them in google
+- Document the tag on https://github.com/simgrid/simgrid/releases and
+ on https://framagit.org/simgrid/simgrid/tags
+ - Upload the files SimGrid-3.XX.tar.gz, simgrid-3_XX.jar and
+ SimGrid-doc-3_XX.zip (that is the artefact of the pages job on framagit) files to the changelog.
+- Update the .gitlab-ci.yml on the website
+ - Download the simgrid-doc from framagit and unpack it in position
+ - Only keep 2 versions so that people don't find older ones in google
- Rebuild and resynchronize the website so that the file gets visible
from our download page.@n
- Edit org/org-templates/level-0.org to change the release version, the tgz link and the jar link.
- emacs org/site/download.org and C-c C-c the first source block to refresh the download.
- emacs org/site/documentation.org and edit the version links.
- make -C org all sync
+ - jed .gitlab-ci.yml
+ - Change the link to the SimGrid-doc-3_XX.zip file
+ - Change the version number
+ - Change the link to latest
- git commit -a && git push
- Announce the release
- - Document the tag on https://github.com/simgrid/simgrid/releases and
- on https://framagit.org/simgrid/simgrid/tags
- Mail the simgrid-user mailing list
- the NEWS chunk in the mail;
- Hall of Fame in the mail@n
- Update the Docker images (after pushing to the git)
- cd tools/docker && make stable tuto-s4u push
+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
+ - Deprecated symbols remain usable for at least 3 named releases (~1 year)
+ - These releases are announced to the users
+ - 3.X.Y is a dot release of 3.X
+ - We provide and store a source .tar.gz and a full jarfile 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
+ release process from ours, when 4 release a year is not enough
+ - 3.X.90 is a git version, a preversion of 3.(X+1) (3.22.90 = pre-3.23)
+ - No expectations on such versions
+
+Doing a dot release:
+ - Update the version number in:
+ - CMakeLists.txt (in macros SIMGRID_VERSION_*)
+ - sonar-project.properties
+ - docs/source/conf.py
+ - Commit and push to both framagit and github
+ - Wait for both appveyor and jenkins/highsierra to complete the build
+ - If it's not successful, fix it and push again
+ - Once it's successful:
+ - tag the release v3_X_Y and push the tag
+ - Merge 'master' into 'stable' and push it to framagit
+ - Do not merge into 'stable' before appveyor and jenkins are done,
+ or your jarfile will not contain the code you expect for win and
+ mac.
+
*/