per #2562, update Release Guide to include instructions for updating …

…the component versions lookup table in the METplus repository
dtcenter · Nov 5, 2024 · f12e3b9 · f12e3b9
1 parent 57c2a8c
commit f12e3b9
Show file tree

Hide file tree

Showing 10 changed files with 92 additions and 0 deletions.
diff --git a/docs/Release_Guide/met_bugfix.rst b/docs/Release_Guide/met_bugfix.rst
@@ -15,4 +15,5 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch.
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/met/update_dtc_website.rst
+.. include:: release_steps/update_version_lookup.rst
 .. include:: release_steps/finalize_release_on_github_bugfix.rst
diff --git a/docs/Release_Guide/metcalcpy_bugfix.rst b/docs/Release_Guide/metcalcpy_bugfix.rst
@@ -15,4 +15,5 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch.
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst
+.. include:: release_steps/update_version_lookup.rst
 .. include:: release_steps/finalize_release_on_github_official.rst
diff --git a/docs/Release_Guide/metdataio_bugfix.rst b/docs/Release_Guide/metdataio_bugfix.rst
@@ -18,4 +18,5 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch.
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/common/update_dtc_website.rst
+.. include:: release_steps/update_version_lookup.rst
 .. include:: release_steps/finalize_release_on_github_bugfix.rst
diff --git a/docs/Release_Guide/metexpress_official.rst b/docs/Release_Guide/metexpress_official.rst
@@ -18,5 +18,6 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/metexpress/pull_changes_and_merge_to_dev.rst
 .. include:: release_steps/update_docs_official.rst
 .. include:: release_steps/metexpress/update_dtc_website.rst
+.. include:: release_steps/update_version_lookup.rst
 .. include:: release_steps/metexpress/announce_release.rst
 .. include:: release_steps/set_beta_deletion_reminder_official.rst
diff --git a/docs/Release_Guide/metplotpy_bugfix.rst b/docs/Release_Guide/metplotpy_bugfix.rst
@@ -14,5 +14,6 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch.
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst
+.. include:: release_steps/update_version_lookup.rst
 .. include:: release_steps/finalize_release_on_github_official.rst
 
diff --git a/docs/Release_Guide/metplus_bugfix.rst b/docs/Release_Guide/metplus_bugfix.rst
@@ -15,4 +15,5 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch.
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/metplus/create_release_extra.rst
 .. include:: release_steps/metplus/update_dtc_website.rst
+.. include:: release_steps/update_version_lookup.rst
 .. include:: release_steps/finalize_release_on_github_official.rst
diff --git a/docs/Release_Guide/metplus_official.rst b/docs/Release_Guide/metplus_official.rst
@@ -23,5 +23,6 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/finalize_release_on_github_official.rst
 .. include:: release_steps/metplus/update_version_on_develop.rst
 .. include:: release_steps/update_docs_official.rst
+.. include:: release_steps/metplus/add_next_version_to_lookup.rst
 .. include:: release_steps/metplus/update_web_server_data.rst
 .. include:: release_steps/set_beta_deletion_reminder_official.rst
diff --git a/docs/Release_Guide/metviewer_bugfix.rst b/docs/Release_Guide/metviewer_bugfix.rst
@@ -15,4 +15,5 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch.
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst
+.. include:: release_steps/update_version_lookup.rst
 .. include:: release_steps/finalize_release_on_github_official.rst
diff --git a/docs/Release_Guide/release_steps/metplus/add_next_version_to_lookup.rst b/docs/Release_Guide/release_steps/metplus/add_next_version_to_lookup.rst
@@ -0,0 +1,38 @@
+Add Next Version to Lookup Table
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In the develop branch, modify the **metplus/component_versions.py** file to
+add an entry for the next coordinated release.
+
+If the X.0 release was just created, add an entry for the X.1 release.
+
+If the X.1 release was just created, add an entry for the X+1.0 release.
+
+Set the appropriate X.Y.0 versions for each component.
+Maybe sure to set the Z number to 0.
+
+Set the version for metexpress to None (not a string).
+
+For example, if the coordinated 6.0 release was just created, add::
+
+    '6.1': {
+        'metplus': '6.1.0',
+        'met': '12.1.0',
+        'metplotpy': '3.1.0',
+        'metcalcpy': '3.1.0',
+        'metdataio': '3.1.0',
+        'metviewer': '6.1.0',
+        'metexpress': None,
+    },
+
+For example, if the coordinated 6.1 release was just created, add::
+
+    '7.0': {
+        'metplus': '7.0.0',
+        'met': '13.0.0',
+        'metplotpy': '4.0.0',
+        'metcalcpy': '4.0.0',
+        'metdataio': '4.0.0',
+        'metviewer': '7.0.0',
+        'metexpress': None,
+    },
diff --git a/docs/Release_Guide/release_steps/update_version_lookup.rst b/docs/Release_Guide/release_steps/update_version_lookup.rst
@@ -0,0 +1,46 @@
+Update Version Lookup Table
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Modify the version lookup table in the METplus repository to include the
+correct version.
+
+.. dropdown:: Instructions
+
+  * Clone the METplus repository.
+
+    Using SSH:
+
+    .. parsed-literal::
+
+        git clone git@github.com:dtcenter/METplus
+
+    Using HTTP:
+
+    .. parsed-literal::
+
+        git clone https://github.com/dtcenter/METplus
+
+  * Enter the METplus repository directory:
+
+  .. parsed-literal::
+
+      cd METplus
+
+  * Checkout the develop branch
+
+  .. parsed-literal::
+
+      git checkout develop
+
+  * Create a branch off of develop to update.
+    Include the name of the repository and version in the name.
+
+    .. parsed-literal::
+
+        git checkout -b update_version_|projectRepo|_vX.Y.Z
+
+  * Open **metplus/component_versions.py** and increment the version for the
+    appropriate |projectRepo| entry.
+
+  * Commit change, push to GitHub, and create a pull request to merge change
+    into the **develop** branch.