Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update SimGrid dates in COPYING file
[simgrid.git] / doc / doxygen / inside_release.doc
index a764f4f..68a8f14 100644 (file)
@@ -8,7 +8,10 @@
 Please apply the following checklist before releasing.
 
 - Sources
-  - The version number is correctly marked in CMakeList.txt, in macros
+  - The external patches (Debian, etc) are integrated.
+    The COPYING file is aligned with Debian's copyright file, and the
+    dates of SimGrid chunks are accurate.
+  - The version number is correctly marked in CMakeLists.txt, in macros
     SIMGRID_VERSION_MAJOR and friends. 
   - The "make distcheck" target works (testing that every files needed
     to build and install are included in the archive)
@@ -20,7 +23,7 @@ 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
+  - 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
@@ -33,7 +36,7 @@ This should be done from a clean git repository because some files are
 included through globbing. The best is to use a clean checkout:
 \verbatim
 cd /tmp
-git clone ~/Code/simgrid
+git clone --depth=1 ~/Code/simgrid
 cd simgrid
 cmake . && make dist
 \endverbatim
@@ -45,7 +48,7 @@ git clean -dfx          # warning, it will kill your uncommited changes
 cmake . && make dist
 \endverbatim
 
-\subsection inside_release_c_source Building the binary jarfile
+\subsection inside_release_c_jarfile Building the binary jarfile
 
 Get the jarfiles for several OSes on the CI slaves. Use Save under to
 give a separate name to each of them.
@@ -82,22 +85,39 @@ the settings icon of the release you want to change.
 - 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
+  (and create the directory of the next version)
 - 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/index.org and C-c C-c the first source block to refresh the news.
+  - emacs org/site/index.org and C-c C-c the first source block to refresh the news; fake the date in the result.
   - 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
-  - git commit && git push
+  - git commit -a && git push
 - Announce the release
+ - Document the tag on https://github.com/simgrid/simgrid/releases
  - Mail the simgrid-user mailing list
     - the NEWS chunk in the mail;
+    - Hall of Fame in the mail\n
+      git shortlog -sne v3.18..
     - the ChangeLog chunk as attachment
  - Also mail some other lists (G5K users), with only the NEWS chunk
    and the link to the download section
-- Release the debian package   
+- Release the debian package
+  - make -C debian/rules get-orig-source
+  - gbp import ../simgrid_XXX+dfsg.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/ 
+    - libsimgrid3.XY conflicts with libsimgrid3.XX because of smpimain
+- Update the simgrid/package.py for spack: https://gitlab.inria.fr/solverstack/spack-repo
 - Create the template for the next release in ChangeLog and NEWS files
-- Change the release number in CMakeLists.txt
+- Change the release number in CMakeLists.txt and sonar-project.properties
+- Deal with deprecations:
+  - Introduce the XBT_ATTRIB_DEPRECATED_v??? macro for the next release.
+  - 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.
 
 */