X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a882344bc908a258a991701e226556ec23fd7cd6..b1245e5ecc0f1eb4e2b76edac0004005e8c9a514:/doc/doxygen/inside_release.doc diff --git a/doc/doxygen/inside_release.doc b/doc/doxygen/inside_release.doc index 1620515cca..d7e84f0e91 100644 --- a/doc/doxygen/inside_release.doc +++ b/doc/doxygen/inside_release.doc @@ -14,7 +14,6 @@ Please apply the following checklist before releasing. - 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 @@ -26,22 +25,22 @@ Please apply the following checklist before releasing. - 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 @@ -49,14 +48,13 @@ Please apply the following checklist before releasing. - 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 + https://framagit.org/simgrid/simgrid/-/blob/v3.35/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 @@ -69,7 +67,7 @@ Please apply the following checklist before releasing. rm -rf /tmp/pysimgrid && mkdir /tmp/pysimgrid && cp dist/simgrid-*.tar.gz /tmp/pysimgrid (cd /tmp/pysimgrid && tar xfz simgrid*.tar.gz && cd simgrid-*/ && python3 setup.py build) - Upload it to pypi (WARNING: you cannot modify uploaded files, ever) - twine upload dist/simgrid-*.tar.gz + twine upload dist/simgrid-*.tar.gz # User and password should be located in ~/.pypirc @subsection inside_release_c_publishing Publishing the release if it's a stable one (3.XX not 3.XX.Y) @@ -81,15 +79,17 @@ Please apply the following checklist before releasing. - Link to the ChangeLog on framagit (the version of that tag) - Also mail some other lists (G5K users) - Release the debian package - - rm -f ../simgrid_3.*+dfsg.orig.tar.xz + - rm -f ../simgrid_3.*.orig.tar.xz - uscan # download the new version - - gbp import-orig ../simgrid_3.*+dfsg.orig.tar.xz + - gbp import-orig ../simgrid_3.*.orig.tar.xz - dch -i "New upstream release" # + copy the NEWS into debian/changelog - 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 - Push the stable branch to github to rebuild and push the stable Docker images - - It downloads the latest tag on framagit + - It downloads the latest tag on framagit, but sometimes gets out of synch. + Make sure that it's really the latest stable, as it sometimes rebuilds the previous release. + If this happens, just rerun the docker-stable action. Nothing should get hurt by the rebuild. - 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 @@ -114,11 +114,11 @@ Release numbering semantic: - 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