Merge branch 'develop' into feature_2741_update_use_cases

dtcenter · Nov 4, 2024 · d1ec2df · d1ec2df
2 parents e8cfd39 + 9a60470
commit d1ec2df
Show file tree

Hide file tree

Showing 33 changed files with 208 additions and 167 deletions.
diff --git a/docs/Release_Guide/met_development.rst b/docs/Release_Guide/met_development.rst
@@ -7,12 +7,14 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 
 .. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
-.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/checkout_source_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/met/update_version_development.rst
 .. include:: release_steps/update_release_notes_development.rst
 .. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/merge_release_issue.rst
+.. include:: release_steps/met/create_release_reference_branch.rst
+.. include:: release_steps/create_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/met/update_dtc_website.rst

diff --git a/docs/Release_Guide/met_official.rst b/docs/Release_Guide/met_official.rst
@@ -7,16 +7,14 @@ Create a new vX.Y.Z official release from the develop branch.
 
 .. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
-.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/checkout_main_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/met/update_version_official.rst
 .. include:: release_steps/update_release_notes_official.rst
 .. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/met/update_web_server_data.rst
-.. include:: release_steps/met/create_release_reference_branch.rst
-.. include:: release_steps/create_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/met/update_dtc_website.rst

diff --git a/docs/Release_Guide/metcalcpy_development.rst b/docs/Release_Guide/metcalcpy_development.rst
@@ -7,12 +7,13 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 
 .. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
-.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/checkout_source_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metcalcpy/update_version.rst
 .. include:: release_steps/update_release_notes_development.rst
 .. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/merge_release_issue.rst
+.. include:: release_steps/create_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst

diff --git a/docs/Release_Guide/metcalcpy_official.rst b/docs/Release_Guide/metcalcpy_official.rst
@@ -7,15 +7,13 @@ Create a new vX.Y.Z official release from the develop branch.
 
 .. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
-.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/checkout_main_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metcalcpy/update_version_official.rst
 .. include:: release_steps/update_release_notes_official.rst
 .. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
-.. include:: release_steps/create_release_branch.rst
-.. include:: release_steps/push_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst

diff --git a/docs/Release_Guide/metdataio_development.rst b/docs/Release_Guide/metdataio_development.rst
@@ -10,12 +10,13 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 
 .. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
-.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/checkout_source_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metdataio/update_version.rst
 .. include:: release_steps/update_release_notes_development.rst
 .. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/merge_release_issue.rst
+.. include:: release_steps/create_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/common/update_dtc_website.rst

diff --git a/docs/Release_Guide/metdataio_official.rst b/docs/Release_Guide/metdataio_official.rst
@@ -10,15 +10,13 @@ Create a new vX.Y.Z official release from the develop branch.
 
 .. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
-.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/checkout_main_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metdataio/update_version_official.rst
 .. include:: release_steps/update_release_notes_official.rst
 .. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
-.. include:: release_steps/create_release_branch.rst
-.. include:: release_steps/push_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/common/update_dtc_website.rst

diff --git a/docs/Release_Guide/metplotpy_development.rst b/docs/Release_Guide/metplotpy_development.rst
@@ -7,12 +7,13 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 
 .. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
-.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/checkout_source_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metplotpy/update_version.rst
-.. include:: release_steps/merge_release_issue.rst
 .. include:: release_steps/update_release_notes_development.rst
 .. include:: release_steps/update_upgrade_instructions.rst
+.. include:: release_steps/merge_release_issue.rst
+.. include:: release_steps/create_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst

diff --git a/docs/Release_Guide/metplotpy_official.rst b/docs/Release_Guide/metplotpy_official.rst
@@ -7,15 +7,13 @@ Create a new vX.Y.Z official release from the develop branch.
 
 .. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
-.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/checkout_main_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metplotpy/update_version_official.rst
 .. include:: release_steps/update_release_notes_official.rst
 .. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
-.. include:: release_steps/create_release_branch.rst
-.. include:: release_steps/push_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst

diff --git a/docs/Release_Guide/metplus_development.rst b/docs/Release_Guide/metplus_development.rst
@@ -7,12 +7,13 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 
 .. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
-.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/checkout_source_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metplus/update_version.rst
 .. include:: release_steps/update_release_notes_development.rst
 .. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/merge_release_issue.rst
+.. include:: release_steps/metplus/create_release_reference_branch.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/metplus/create_release_extra.rst
 .. include:: release_steps/metplus/update_version_on_develop.rst

diff --git a/docs/Release_Guide/metplus_official.rst b/docs/Release_Guide/metplus_official.rst
@@ -7,21 +7,19 @@ Create a new vX.Y.Z official release from the develop branch.
 
 .. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
-.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/checkout_main_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
+.. include:: release_steps/metplus/update_version_official.rst
 .. include:: release_steps/metplus/update_release_date.rst
 .. include:: release_steps/update_release_notes_official.rst
 .. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/metplus/update_manage_externals.rst
 .. include:: release_steps/merge_release_issue.rst
-.. include:: release_steps/metplus/create_release_reference_branch.rst
-.. include:: release_steps/push_release_branch.rst
 .. 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/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/update_web_server_data.rst
 .. include:: release_steps/set_beta_deletion_reminder_official.rst
diff --git a/docs/Release_Guide/metviewer_development.rst b/docs/Release_Guide/metviewer_development.rst
@@ -7,12 +7,13 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 
 .. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
-.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/checkout_source_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metviewer/update_version.rst
 .. include:: release_steps/update_release_notes_development.rst
 .. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/merge_release_issue.rst
+.. include:: release_steps/create_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst

diff --git a/docs/Release_Guide/metviewer_official.rst b/docs/Release_Guide/metviewer_official.rst
@@ -7,15 +7,13 @@ Create a new vX.Y.Z official release from the develop branch.
 
 .. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
-.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/checkout_main_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
 .. include:: release_steps/metviewer/update_version_official.rst
 .. include:: release_steps/update_release_notes_official.rst
 .. include:: release_steps/update_upgrade_instructions.rst
 .. include:: release_steps/rotate_authorship.rst
 .. include:: release_steps/merge_release_issue.rst
-.. include:: release_steps/create_release_branch.rst
-.. include:: release_steps/push_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/create_release_extra.rst
 .. include:: release_steps/update_dtc_website.rst

diff --git a/docs/Release_Guide/release_steps/checkout_develop_branch.rst b/docs/Release_Guide/release_steps/checkout_develop_branch.rst
diff --git a/docs/Release_Guide/release_steps/checkout_main_branch.rst b/docs/Release_Guide/release_steps/checkout_main_branch.rst
@@ -2,7 +2,7 @@ Checkout the Main Branch
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 Checkout the main branch for the X.Y release. If you are creating
-the |projectRepo|-X.Y.Z bugfix release, checkout main_vX.Y.
+the |projectRepo|-X.Y.Z official or bugfix release, checkout main_vX.Y.
 
 .. parsed-literal::
 

diff --git a/docs/Release_Guide/release_steps/checkout_source_branch.rst b/docs/Release_Guide/release_steps/checkout_source_branch.rst
@@ -0,0 +1,18 @@
+Checkout the Source Branch
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* If creating a **beta** (betaN) or **first release candidate** (rc1) release,
+  checkout the develop branch:
+
+.. parsed-literal::
+
+    git checkout develop
+
+**OR**
+
+* If creating a **later release candidate** (rc2+) release,
+  checkout the appropriate main branch:
+
+.. parsed-literal::
+
+    git checkout main_vX.Y
diff --git a/docs/Release_Guide/release_steps/create_release_branch.rst b/docs/Release_Guide/release_steps/create_release_branch.rst
@@ -1,7 +1,16 @@
 Create Release Branch
 ^^^^^^^^^^^^^^^^^^^^^
 
-* Create a branch from the develop branch for the new official release and push it to GitHub.
+.. note::
+
+  These instructions only apply when creating the **first release candidate**
+  (rc1) development release. Skip this section for earlier beta (betaN) or later 
+  release candidate (rc2+) development releases.
+
+
+* Create a new 'main_vX.Y' branch from the develop branch for the upcoming
+  official release and push it to GitHub. All remaining development for the
+  upcoming official release occurs on this new 'main_vX.Y' branch.
 
 .. parsed-literal::
 

diff --git a/docs/Release_Guide/release_steps/create_release_on_github.rst b/docs/Release_Guide/release_steps/create_release_on_github.rst
@@ -3,11 +3,17 @@ Create Release on GitHub
 
 * Go to Releases on GitHub and click 'Draft a new release'
 
-* Set the tag based on the version, starting with 'v', i.e. vX.Y.Z-betaN, vX.Y.Z-rcN, or vX.Y.Z
+* For 'Choose a tag', create a new tag based on the version, starting with 'v'
+  (i.e. vX.Y.Z-betaN, vX.Y.Z-rcN, or vX.Y.Z)
 
-* Set the branch value to 'develop' for a development release or 'main_vX.Y' for a bugfix or official release
+* Define the 'Target' branch as:
 
-* Choose a release name (i.e. |projectRepo|-X.Y.Z-betaN, |projectRepo|-X.Y.Z-rcN, or |projectRepo|-X.Y.Z)
+  * 'develop' for a beta development release
+
+  * 'main_vX.Y' for a release candidate, bugfix, or official release
+
+* Define the 'Release title' based on the repository name and version, *without* a leading 'v'
+  (i.e. |projectRepo|-X.Y.Z-betaN, |projectRepo|-X.Y.Z-rcN, or |projectRepo|-X.Y.Z)
 
 * Add a link to the release notes from the |projectRepo| User's Guide, i.e.
   https://|projectRepo|.readthedocs.io/en/vX.Y.Z-betaN/Users_Guide/release-notes.html

diff --git a/docs/Release_Guide/release_steps/met/create_release_reference_branch.rst b/docs/Release_Guide/release_steps/met/create_release_reference_branch.rst
@@ -1,9 +1,16 @@
 Create Release Reference Branch
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+.. note::
+
+  These instructions only apply when creating the **first release candidate**
+  (rc1) development release. Skip this section for earlier beta (betaN) or later 
+  release candidate (rc2+) development releases.
+
+
 * Create a branch from the develop branch for the reference branch for the
   new official release and push it to GitHub. The branch name should match
-  the format main_vX.Y-ref where X.Y is the major/minor release number.
+  the format 'main_vX.Y-ref' where X.Y is the major/minor release number.
 
 .. parsed-literal::
 
@@ -22,14 +29,14 @@ Push Reference Branch to GitHub
 Pushing this branch to GitHub should trigger the GitHub Actions automation
 that runs all of the use cases and creates Docker data volumes with the output
 data. These data will be used to verify that any bugfixes applied to the
-main_vX.Y branch does not break any of existing logic.
+'main_vX.Y' branch does not break any of existing logic.
 
 Monitor GitHub Actions Workflow
 """""""""""""""""""""""""""""""
 
 Navigate to https://github.com/dtcenter/MET/actions and verify that a
-*Testing* workflow was triggered on the *main_vX.Y-ref* branch.
+'Testing' workflow was triggered on the 'main_vX.Y-ref' branch.
 
 * Wait until the entire workflow has run successfully. The final job entitled
-  "Create Output Docker Data Volumes" should create Docker data volumes for
+  'Create Output Docker Data Volumes' should create Docker data volumes for
   each use case category on DockerHub (dtcenter/met-dev).
diff --git a/docs/Release_Guide/release_steps/met/update_version_bugfix.rst b/docs/Release_Guide/release_steps/met/update_version_bugfix.rst
@@ -3,8 +3,8 @@ Update Version Number
 
 * Update the version in the code and documentation:
 
-  * Update the *met_version* variable in *src/basic/vx_util/util_constants.h* which defines the version number written to the MET output files.
+  * Update the 'met_version' variable in 'src/basic/vx_util/util_constants.h' which defines the version number written to the MET output files.
 
-  * In *docs/conf.py*, update the *version*, *release_year*, and *release_date* variables for the documentation.
+  * In 'docs/conf.py', update the 'version', 'release_year', and 'release_date' variables for the documentation.
 
   * DO NOT update the version number listed in the MET configuration files, add a new table file, or add a new test header file.
diff --git a/docs/Release_Guide/release_steps/met/update_version_development.rst b/docs/Release_Guide/release_steps/met/update_version_development.rst
@@ -1,10 +1,11 @@
 Update Version Number
 ^^^^^^^^^^^^^^^^^^^^^
+
+.. note::
 
-* Prior to creating the first development release (e.g. beta1) for a new version, the official release version number should have already been updated.
+  The software version number should have been updated for the next official release during development toward the **first development release** (e.g. beta1).
+  If not, follow the :ref:`official release instructions <update_version_official>` to do so prior to creating the first development release.
 
-* If the official release version has not yet been updated (e.g. beta1), follow the :ref:`official release instructions <update_version_official>` to do so.
+* If the official release version has already been updated (e.g. beta2+ and rc1+), do the following:
 
-* If the official release version has already been updated (e.g. beta2 and beyond), do the following:
-
-  * In *docs/conf.py*, update the *version*, *release_year*, and *release_date* variables for the documentation.
+  * In 'docs/conf.py', update the 'version', 'release_year', and 'release_date' variables for the documentation.
diff --git a/docs/Release_Guide/release_steps/met/update_version_official.rst b/docs/Release_Guide/release_steps/met/update_version_official.rst
@@ -5,20 +5,20 @@ Update Version Number
 
 * Update the version in the code and documentation:
 
-  * If necessary, update the *met_version* variable in *src/basic/vx_util/util_constants.h* which defines the version number written to the MET output files.
+  * If necessary, update the 'met_version' variable in 'src/basic/vx_util/util_constants.h' which defines the version number written to the MET output files.
 
-  * In *docs/conf.py*, update the *version*, *release_year*, and *release_date* variables for the documentation.
+  * In 'docs/conf.py', update the 'version', 'release_year', and 'release_date' variables for the documentation.
 
-  * In *docs/Users_Guide/installation.rst*, search for the X.Y version, replacing the current X.Y version with the official X.Y version, if necessary. Pay particular attention to the "Note" about the C++ standard and modify if necessary.  The X.Y version number in the "Note" box should NOT change unless the default C++ standard changes.
+  * In 'docs/Users_Guide/installation.rst', search for the X.Y version, replacing the current X.Y version with the official X.Y version, if necessary. Pay particular attention to the "Note" about the C++ standard and modify if necessary.  The X.Y version number in the "Note" box should NOT change unless the default C++ standard changes.
 
   * If necessary, update the version number listed in the MET configuration files:
 
-    * Default configuration files in *data/config*.
+    * Default configuration files in 'data/config'.
 
-    * Sample configuration files in *scripts/config*.
+    * Sample configuration files in 'scripts/config'.
 
-    * Test configuration files, searching recursively, in *internal/test_unit/config*.
+    * Test configuration files, searching recursively, in 'internal/test_unit/config'.
 
-  * If necessary, add a new *data/table_files/met_header_columns_VX.Y.txt* defining the columns names for this version.
+  * If necessary, add a new 'data/table_files/met_header_columns_VX.Y.txt' defining the columns names for this version.
 
-  * If necessary, add a new *internal/test_unit/hdr/met_X_Y.hdr* file defining the column names for this version for the test scripts.
+  * If necessary, add a new 'internal/test_unit/hdr/met_X_Y.hdr' file defining the column names for this version for the test scripts.