Feature 1553 weather regime

.github/jobs/docker_setup.sh

@@ -36,11 +36,17 @@ MET_TAG=`${GITHUB_WORKSPACE}/scripts/docker/hooks/get_met_version`
 MET_DOCKER_REPO=met-dev
 if [ "${MET_TAG}" != "develop" ]; then
     MET_DOCKER_REPO=met
+elif [ "${EXTERNAL_TRIGGER}" == "true" ]; then
+    # if MET tag is develop and external repo triggered workflow
+    # then append -lite to MET tag name to use tag generated by
+    # MET GHA workflow that does not include MET unit test tools
+    MET_TAG=${MET_TAG}-lite
 fi
 
 # if MET_FORCE_TAG variable is set and not empty, use that version instead
 if [ ! -z "$MET_FORCE_TAG" ]; then
     MET_TAG=$MET_FORCE_TAG
+    MET_DOCKER_REPO=met
 fi
 
 echo Using MET_DOCKER_REPO=$MET_DOCKER_REPO

.github/jobs/get_use_cases_to_run.sh

@@ -9,7 +9,7 @@ run_all_use_cases=$2
 run_unit_tests=$3
 
 echo Run use cases: $run_use_cases
-echo Run All use cases: $run_all_use_cases
+echo Run all use cases: $run_all_use_cases
 echo Run unit tests: $run_unit_tests
 
 # if running use cases, generate JQ filter to use

.github/jobs/set_job_controls.sh

@@ -94,3 +94,11 @@ echo ::set-output name=branch_name::$branch_name
 
 # get use cases to run
 .github/jobs/get_use_cases_to_run.sh $run_use_cases $run_all_use_cases $run_unit_tests
+
+# echo output variables to review in logs
+echo branch_name: $branch_name
+echo run_diff: $run_diff
+echo run_save_truth_data: $run_save_truth_data
+echo external_trigger: $external_trigger
+echo run_get_image: $run_get_image
+echo run_get_input_data: $run_get_input_data

.github/parm/use_case_groups.json

@@ -61,12 +61,12 @@
   },
   {
     "category": "marine_and_cryosphere",
-    "index_list": "3-4",
+    "index_list": "3-5",
     "run": false
   },
   {
     "category": "marine_and_cryosphere",
-    "index_list": "5",
+    "index_list": "6",
     "run": false
   },
   {

.github/workflows/testing.yml

@@ -84,6 +84,7 @@ jobs:
         env:
           DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
           DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+          EXTERNAL_TRIGGER: ${{ needs.job_control.outputs.external_trigger }}
           #MET_FORCE_TAG: 10.0.0
 
   update_data_volumes:

docs/Release_Guide/met_official.rst

@@ -13,6 +13,7 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/update_release_notes_official.rst
 .. include:: release_steps/rotate_authorship.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

docs/Release_Guide/metplus_official.rst

@@ -15,7 +15,6 @@ Create a new vX.Y.Z official release from the develop branch.
 .. 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/metplus/update_release_content.rst
 .. include:: release_steps/push_release_branch.rst
 .. include:: release_steps/create_release_on_github.rst
 .. include:: release_steps/metplus/create_release_extra.rst

docs/Release_Guide/release_steps/create_release_on_github.rst

@@ -13,7 +13,6 @@ Create Release on GitHub
   https://|projectRepo|.readthedocs.io/en/vX.Y.Z-betaN/Users_Guide/release-notes.html
   (Note: the URL will not be active until the release is created)
 
-* Add a link to the PDF of the |projectRepo| User's Guide, if available.
-  The PDF can be downloaded from ReadTheDocs if it is available, i.e.
+* Add links to the HTML and PDF versions of the |projectRepo| User's Guide on ReadTheDocs.
   https://|projectRepo|.readthedocs.io/_/downloads/en/vX.Y.Z-betaN/pdf/
   (Note: the URL will not be active until the release is created)

docs/Release_Guide/release_steps/finalize_release_on_github_official.rst

@@ -1,19 +1,37 @@
 Finalize Release on GitHub
 --------------------------
 
-* Close the GitHub issue for creating this official release.
-* Edit the milestone for the current release by updating the *Due date* with the actual release date.
-* If necessary, create a new milestone for the next official release (e.g. next vX.Y.Z release).
-* If necessary, reassign any remaining issues for the current milestone to the next one.
-* Close the current milestone.
-* Confirm that all existing development projects for the current milestone are closed.
-* If necessary, create development projects for the next milestone (e.g. |projectRepo|-X.Y.Z-beta1, beta2, beta3).
-* Update the repository settings by resetting the *Default branch* to the new main_vX.Y branch:
+* Update milestones:
+
+  * Edit the milestone for the current release by updating the *Due date* with the actual release date.
+
+  * Close the current milestone.
+
+  * Create a new milestone for the first bugfix release (e.g. first vX.Y.1 (bugfix) release).
+
+  * If necessary, create a new milestone for the next official release (e.g. next vX.Y.Z release).
+
+* Update issues:
+
+  * Close the GitHub issue for creating this official release.
+
+  * If necessary, reassign any remaining issues for the current milestone to other milestones.
+
+* Update projects:
+
+  * Confirm that all existing development projects for the current milestone are closed.
+
+  * If necessary, create development projects for the next milestone (e.g. |projectRepo|-X.Y.Z-beta1, beta2, beta3).
+
+* Update branches:
+
+  * Remove any remaining stale development branches from the new release.
+
+  * Update the repository settings by resetting the *Default branch* to the new main_vX.Y branch:
 
 .. parsed-literal::
 
      https://github.com/dtcenter/|projectRepo|
      -> Settings
      -> Branches (tab on left)
      -> change the drop down to new branch
-

docs/Release_Guide/release_steps/met/create_release_reference_branch.rst

@@ -0,0 +1,35 @@
+Create Release Reference Branch
+-------------------------------
+
+* 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.
+
+.. parsed-literal::
+
+    cd |projectRepo|
+    git checkout develop
+    git pull
+    git checkout -b main_vX.Y-ref
+
+Push Reference Branch to GitHub
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+::
+
+    git push -u origin main_vX.Y-ref
+
+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.
+
+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.
+
+* Wait until the entire workflow has run successfully. The final job entitled
+  "Create Output Docker Data Volumes" should create Docker data volumes for
+  each use case category on DockerHub (dtcenter/met-dev).

docs/Release_Guide/release_steps/metplus/create_release_reference_branch.rst

@@ -18,13 +18,41 @@ Create Release Reference Branch
     git checkout develop
     git pull
     git checkout -b main_vX.Y-ref
+
+Update the version number
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Update the content that should go into the release version but remain unchanged
+in the develop branch.
+
+Remove **-dev** from the version number:
+
+* As of METplus 4.0.0, we are naming releases with X.Y.Z format even if Z is 0.
+* As of METplus v4.0.0, the file containing the version number is located at
+  **metplus/VERSION** (in earlier releases, the file was located at
+  docs/version or doc/version).
+* In the develop branch, the version should match the upcoming release
+  with -dev added to the end like X.Y.Z-betaN-dev, i.e. 4.0.0-beta1-dev
+* Remove **-dev** from the version number so that it matches the release
+  you are creating.
+
+Commit these changes.
+
+Push Reference Branch to GitHub
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+::
+
     git push -u origin main_vX.Y-ref
 
 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.
 
+Monitor GitHub Actions Workflow
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 Navigate to https://github.com/dtcenter/METplus/actions and verify that a
 *Testing* workflow was triggered on the *main_vX.Y-ref* branch.
 
@@ -35,6 +63,9 @@ Navigate to https://github.com/dtcenter/METplus/actions and verify that a
   each use case category on DockerHub (dtcenter/metplus-data-dev). The names
   of these volumes start with *output-*.
 
+Create main branch and push to GitHub
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 * After the truth data volumes have been generated, create the main_vX.Y
   branch off of the -ref branch.
 

docs/Release_Guide/release_steps/open_release_issue.rst

@@ -7,7 +7,7 @@ Open Release Issue
 
   * "Create the |projectRepo| vX.Y.Z-betaN (or -rcN) release" for a development release.
 
-* For an official or development release, assign the issue to the current |projectRepo| development project.
+* For an official or development release, assign the issue to the corresponding |projectRepo| development project.
 
 * For a bugfix release, assign the issue to the organization level support project.