Merge pull request #632 from MaxThevenet/release_script

Add script to update version number in all source files

Author: MaxThevenet

Docs/source/developers/developers.rst

@@ -20,3 +20,4 @@ Our Doxygen API documentation in classic formatting `is located here <../_static
    portability
    profiling
    documentation
+   workflow

Docs/source/developers/workflow.rst

@@ -0,0 +1,19 @@
+.. _developers-workflow:
+
+Workflow
+========
+
+Make a new Github release
+-------------------------
+
+WarpX has one release per month. To make the release, you need to:
+
+    * Update the version number in all source files. There is a script for that, so you can do:
+
+      .. code-block:: sh
+          cd Tools/
+          ./update_release.sh
+
+    * Merge ``dev`` branch into ``master`` branch.
+
+    * Click the `Draft a new release` button at https://github.com/ECP-WarpX/WarpX/releases and follow instructions.

Tools/update_release.sh

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# This script updates release version number in all source files.
+#
+# updates occurences like "version = '??.??'" where ??.?? is the version number
+# updates occurences like "WarpX v??.??" where ??.?? is the version number
+#
+# Requirements:
+# - gnu grep (default grep on MacOS does not have same -P option)
+# - gnu sed  (default grep on MacOS does not have same -i option)
+
+set -e
+
+# Get old tag number from git
+git_tag=`git describe --tags`
+old_release_number="${git_tag%%-*}"
+
+# Construct new tag number from current date
+d=`date +%Y.%m`
+new_release_number=${d:2}
+
+echo "Replace release number $old_release_number by $new_release_number"
+
+# Loop over files and sed patterns with version number
+pattern="\.c$|\.cpp$|\.F90$|\.h$|\.H$|\.ini$|\.md$|\.py$|"\
+"\.rst$|\.sh$|\.tex$|\.txt$|\.xml$|\.yml$|"\
+"CMakeLists\.txt|inputs"
+for i in $(find .. \
+                -not -path "../.git/*"   \
+                -not -path "../.idea/*"  \
+                -not -path "../Docs/source/api/*" \
+                -not -path "../Docs/build/*" \
+                -not -path "../Docs/doxyxml/*" \
+                -not -path "*wp_parse*" \
+                -not -path "../tmp_build_dir/*" \
+                -type f | \
+           grep -P "${pattern}")
+do
+    echo $i
+    # update occurences like "version = '??.??'" where ??.?? is the version number
+    # Note: sleep is required due to a bug in sed: without, the file
+    # permissions are modified
+    sed -i "s/version = "\'"$old_release_number"\'"/version = "\'"$new_release_number"\'"/g" $i && sleep .001
+    # update occurences like "WarpX v??.??" where ??.?? is the version number
+    sed -i "s/WarpX v$old_release_number/WarpX v$new_release_number/g" $i && sleep .001
+done
+
+echo ""
+echo "WARNING: Remaining occurences of $old_release_number are listed below."
+echo "         Is this expected? Or should these be updated too?"
+echo ""
+git grep "$old_release_number" .