Add --release option for script to update dependencies (#6033)

Added the new command line option `--release` to the script
`update_dependencies.py` which automatically uses the version tag (e.g.,
`25.07`) instead of the commit hash to replace the commit field in the
dependencies file.

Author: EZoni

Docs/source/maintenance/release.rst

@@ -19,6 +19,7 @@ The script ``update_dependencies.py`` from `Tools/Release/update_dependencies.py
        --pyamrex   Update pyAMReX only
        --picsar    Update PICSAR only
        --warpx     Update WarpX only
+       --release   New release
 
 Create a new WarpX release
 --------------------------
@@ -34,6 +35,7 @@ In order to create a GitHub release, you need to:
     The script above can be used to update the core dependencies of WarpX and the WarpX version.
 
     For a WarpX release, ideally a *git tag* of AMReX & PICSAR shall be used instead of an unnamed commit.
+    This can be done by running the script above with the command line option ``--release``.
 
     Then open a PR, wait for tests to pass and then merge.
 

Tools/Release/releasePR.py

@@ -74,7 +74,11 @@ def concat_answers(answers):
 answers = concat_answers(["y", AMReX_version, AMReX_version, "y"])
 
 process = subprocess.Popen(
-    [Path(REPO_DIR).joinpath("Tools/Release/update_dependencies.py"), "--amrex"],
+    [
+        Path(REPO_DIR).joinpath("Tools/Release/update_dependencies.py"),
+        "--amrex",
+        "--release",
+    ],
     stdin=subprocess.PIPE,
     stdout=subprocess.PIPE,
     stderr=subprocess.PIPE,
@@ -97,7 +101,11 @@ def concat_answers(answers):
 answers = concat_answers(["y", PICSAR_version, PICSAR_version, "y"])
 
 process = subprocess.Popen(
-    [Path(REPO_DIR).joinpath("Tools/Release/update_dependencies.py"), "--picsar"],
+    [
+        Path(REPO_DIR).joinpath("Tools/Release/update_dependencies.py"),
+        "--picsar",
+        "--release",
+    ],
     stdin=subprocess.PIPE,
     stdout=subprocess.PIPE,
     stderr=subprocess.PIPE,
@@ -120,7 +128,11 @@ def concat_answers(answers):
 answers = concat_answers(["y", pyAMReX_version, pyAMReX_version, "y"])
 
 process = subprocess.Popen(
-    [Path(REPO_DIR).joinpath("Tools/Release/update_dependencies.py"), "--pyamrex"],
+    [
+        Path(REPO_DIR).joinpath("Tools/Release/update_dependencies.py"),
+        "--pyamrex",
+        "--release",
+    ],
     stdin=subprocess.PIPE,
     stdout=subprocess.PIPE,
     stderr=subprocess.PIPE,
@@ -142,7 +154,11 @@ def concat_answers(answers):
 answers = concat_answers(["y", WarpX_version_yr, WarpX_version_mn, "", "", "y"])
 
 process = subprocess.Popen(
-    [Path(REPO_DIR).joinpath("Tools/Release/update_dependencies.py"), "--warpx"],
+    [
+        Path(REPO_DIR).joinpath("Tools/Release/update_dependencies.py"),
+        "--warpx",
+        "--release",
+    ],
     stdin=subprocess.PIPE,
     stdout=subprocess.PIPE,
     stderr=subprocess.PIPE,
@@ -174,14 +190,15 @@ def concat_answers(answers):
         f"""Prepare the {datetime.now().strftime("%B")} release of WarpX:
 ```bash
 # update dependencies
-./Tools/Release/update_dependencies.py --amrex
-./Tools/Release/update_dependencies.py --picsar # no changes, still {PICSAR_version}
-./Tools/Release/update_dependencies.py --pyamrex
+./Tools/Release/update_dependencies.py --amrex --release
+./Tools/Release/update_dependencies.py --picsar --release # no changes, still {PICSAR_version}
+./Tools/Release/update_dependencies.py --pyamrex --release
 # bump version number
-./Tools/Release/update_dependencies.py --warpx
+./Tools/Release/update_dependencies.py --warpx --release
 ```
 
-Following this workflow: https://warpx.readthedocs.io/en/latest/maintenance/release.html
+This pull request was created with the script `./Tools/Release/releasePR.py`,
+following the instructions described in https://warpx.readthedocs.io/en/latest/maintenance/release.html#create-a-new-warpx-release.
 """,
         "--label",
         "component: documentation",

Tools/Release/update_dependencies.py

@@ -63,16 +63,18 @@ def update(args):
         repo_commit = repo_gh.json()["sha"]
         # set new repository version
         repo_version = datetime.date.today().strftime("%y.%m")
+        # use version tag for new release
+        new_commit = repo_version if args.release else repo_commit
         # update repository commit
         if repo_name != "warpx":
             print(f"- old commit: {dependencies_data[commit_key]}")
-            print(f"- new commit: {repo_commit}")
+            print(f"- new commit: {new_commit}")
             proceed = input("Do you want to continue? [y/n] ")
             if proceed not in ["y", "Y"]:
                 print("Skipping commit update...")
             else:
                 print("Updating commit...")
-                dependencies_data[f"commit_{repo_name}"] = repo_commit
+                dependencies_data[f"commit_{repo_name}"] = new_commit
         # update repository version
         print(f"- old version: {dependencies_data[version_key]}")
         print(f"- new version: {repo_version}")
@@ -124,6 +126,14 @@ def update(args):
         dest="warpx",
     )
 
+    # add arguments: release option
+    parser.add_argument(
+        "--release",
+        help="New release",
+        action="store_true",
+        dest="release",
+    )
+
     # parse arguments
     args = parser.parse_args()
 

Tools/Release/weeklyUpdate.py

@@ -168,7 +168,8 @@ def concat_answers(answers):
 ./Tools/Release/update_dependencies.py --picsar
 ```
 
-This pull request was created with this script: `./Tools/Release/weeklyUpdate.py`
+This pull request was created with the script `./Tools/Release/weeklyUpdate.py`,
+following the instructions described in https://warpx.readthedocs.io/en/latest/maintenance/release.html#update-warpx-core-dependencies.
 """,
         "--label",
         "component: documentation",