Update Develop-ref after #1121 (#1126)

Co-authored-by: George McCabe <mccabe@ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>
Co-authored-by: johnhg <johnhg@ucar.edu>
Co-authored-by: George McCabe <mccabe@dakota.rap.ucar.edu>
Co-authored-by: Keith Searight <searight@ucar.edu>
Co-authored-by: Hank Fisher <fisherh@kiowa.rap.ucar.edu>
Co-authored-by: MET Tools Test Account <met_test@kiowa.rap.ucar.edu>
Co-authored-by: Julie.Prestopnik <jpresto@ucar.edu>
Co-authored-by: Lisa Goodrich <lisag@ucar.edu>
Co-authored-by: jprestop <jpresto@ucar.edu>
Co-authored-by: bikegeek <minnawin@ucar.edu>
Co-authored-by: John Halley Gotway <johnhg@ucar.edu>
Co-authored-by: Minna Win <minnawin@kiowa.rap.ucar.edu>
Co-authored-by: Daniel Adriaansen <dadriaan@ucar.edu>
Co-authored-by: Christina Kalb <kalb@ucar.edu>
Co-authored-by: George McCabe <mccabe@cheyenne1.cheyenne.ucar.edu>
Co-authored-by: George McCabe <mccabe@cheyenne5.cheyenne.ucar.edu>
Co-authored-by: George McCabe <mccabe@cheyenne4.cheyenne.ucar.edu>
Co-authored-by: Christina Kalb <kalb@kiowa.rap.ucar.edu>
Co-authored-by: bikegeek <3753118+bikegeek@users.noreply.github.com>
Co-authored-by: Julie Prestopnik <jpresto@seneca.rap.ucar.edu>
Co-authored-by: j-opatz <59586397+j-opatz@users.noreply.github.com>
Co-authored-by: Dan Adriaansen <dadriaan@ucar.edu>
Co-authored-by: mrinalbiswas <biswas@ucar.edu>
Co-authored-by: Keith Searight <keith.searight@noaa.gov>
Co-authored-by: Molly Smith <molly.b.smith@noaa.gov>
Co-authored-by: Hank Fisher <fisherh@ucar.edu>
Co-authored-by: Tatiana Burek <tatiana@ucar.edu>
Co-authored-by: Venita Hagerty <38571614+venitahagerty@users.noreply.github.com>
Co-authored-by: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com>
Co-authored-by: George McCabe <mccabe@seneca.rap.ucar.edu>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,7 +2,7 @@
 name: Bug report
 about: Fix something that's not working
 title: ''
-labels: 'type: bug'
+labels: 'alert: NEED ACCOUNT KEY, alert: NEED MORE DEFINITION, alert: NEED PROJECT ASSIGNMENT, type: bug'
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/enhancement_request.md

@@ -2,7 +2,7 @@
 name: Enhancement request
 about: Improve something that it's currently doing
 title: ''
-labels: 'type: enhancement'
+labels: 'alert: NEED ACCOUNT KEY, alert: NEED MORE DEFINITION, alert: NEED PROJECT ASSIGNMENT, type: enhancement'
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/new_feature_request.md

@@ -2,7 +2,7 @@
 name: New feature request
 about: Make it do something new
 title: ''
-labels: 'type: new feature'
+labels: 'alert: NEED ACCOUNT KEY, alert: NEED MORE DEFINITION, alert: NEED PROJECT ASSIGNMENT, type: new feature'
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/new_use_case.md

@@ -2,7 +2,7 @@
 name: New use case
 about: Add a new use case
 title: ''
-labels: 'type: new use case'
+labels: 'alert: NEED ACCOUNT KEY, alert: NEED MORE DEFINITION, alert: NEED PROJECT ASSIGNMENT, type: new use case'
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/sub-issue.md

@@ -2,7 +2,7 @@
 name: Sub-Issue
 about: Break an issue down into smaller parts
 title: ''
-labels: 'type: sub-issue'
+labels: 'alert: NEED ACCOUNT KEY, alert: NEED MORE DEFINITION, alert: NEED PROJECT ASSIGNMENT, type: sub-issue'
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/task.md

@@ -2,7 +2,7 @@
 name: Task
 about: Describe something that needs to be done
 title: ''
-labels: 'type: task'
+labels: 'alert: NEED ACCOUNT KEY, alert: NEED MORE DEFINITION, alert: NEED PROJECT ASSIGNMENT, type: task'
 assignees: ''
 
 ---

.github/jobs/get_use_cases_to_run.sh

@@ -18,8 +18,8 @@ if [ "$run_use_cases" == "true" ]; then
 
   # if only running new use cases, add to filter criteria
   if [ "$run_all_use_cases" == "false" ]; then
-    echo Only run new use cases
-    matrix=$(jq '[.[] | select(.new == true) | (.category + ":" + .index_list)]' $use_case_groups_filepath)
+    echo "Only run use cases that are marked to run every time (run = true)"
+    matrix=$(jq '[.[] | select(.run == true) | (.category + ":" + .index_list)]' $use_case_groups_filepath)
   else
     echo Add all available use cases
     matrix=$(jq '[.[] | (.category + ":" + .index_list)]' $use_case_groups_filepath)

.github/jobs/set_job_controls.sh

@@ -73,11 +73,15 @@ else
     run_all_use_cases=false
   fi
 
-  if grep -q "ci-run-diff" <<< "$commit_msg"; then
+  if grep -q "ci-run-all-diff" <<< "$commit_msg"; then
     run_all_use_cases=true
     run_diff=true
   fi
 
+  if grep -q "ci-run-diff" <<< "$commit_msg"; then
+    run_diff=true
+  fi
+
   if grep -q "ci-run-all-cases" <<< "$commit_msg"; then
     run_use_cases=true
     run_all_use_cases=true

.github/parm/use_case_groups.json

@@ -1,147 +1,147 @@
 [
   {
     "category": "met_tool_wrapper",
-    "index_list": "0-55",
-    "new": false
+    "index_list": "0-57",
+    "run": false
   },
   {
     "category": "air_quality_and_comp",
     "index_list": "0",
-    "new": false
+    "run": false
   },
   {
     "category": "climate",
     "index_list": "0-1",
-    "new": false
+    "run": false
   },
   {
     "category": "convection_allowing_models",
     "index_list": "0",
-    "new": false
+    "run": false
   },
   {
     "category": "convection_allowing_models",
     "index_list": "1",
-    "new": false
+    "run": false
   },
   {
     "category": "convection_allowing_models",
     "index_list": "2-6",
-    "new": false
+    "run": false
   },
   {
     "category": "convection_allowing_models",
     "index_list": "7",
-    "new": false
+    "run": false
   },
   {
     "category": "convection_allowing_models",
     "index_list": "8",
-    "new": false
+    "run": false
   },
   {
     "category": "cryosphere",
     "index_list": "0",
-    "new": false
+    "run": false
   },
   {
     "category": "data_assimilation",
     "index_list": "0",
-    "new": false
+    "run": false
   },
   {
     "category": "marine_and_coastal",
     "index_list": "0-1",
-    "new": false
+    "run": false
   },
   {
     "category": "medium_range",
     "index_list": "0",
-    "new": false
+    "run": false
   },
   {
     "category": "medium_range",
     "index_list": "1-2",
-    "new": false
+    "run": false
   },
   {
     "category": "medium_range",
     "index_list": "3-5",
-    "new": false
+    "run": false
   },
   {
     "category": "medium_range",
     "index_list": "6",
-    "new": false
+    "run": false
   },
   {
     "category": "medium_range",
     "index_list": "7",
-    "new": false
+    "run": false
   },
   {
     "category": "precipitation",
     "index_list": "0",
-    "new": false
+    "run": false
   },
   {
     "category": "precipitation",
     "index_list": "1",
-    "new": false
+    "run": false
   },
   {
     "category": "precipitation",
     "index_list": "2",
-    "new": false
+    "run": false
   },
   {
     "category": "precipitation",
     "index_list": "3-8",
-    "new": false
+    "run": false
   },
   {
     "category": "s2s",
     "index_list": "0",
-    "new": false
+    "run": false
   },
   {
     "category": "s2s",
     "index_list": "1-3",
-    "new": false
+    "run": false
   },
   {
     "category": "s2s",
     "index_list": "4",
-    "new": false
+    "run": false
   },
   {
     "category": "s2s",
     "index_list": "5",
-    "new": false
+    "run": false
   },
   {
     "category": "s2s",
     "index_list": "6-7",
-    "new": false
+    "run": false
   },
   {
     "category": "s2s",
     "index_list": "8-9",
-    "new": false
+    "run": false
   },
   {
     "category": "space_weather",
     "index_list": "0-1",
-    "new": false
+    "run": false
   },
   {
     "category": "tc_and_extra_tc",
     "index_list": "0-2",
-    "new": false
+    "run": false
   },
   {
     "category": "tc_and_extra_tc",
     "index_list": "3",
-    "new": false
+    "run": false
   }
 ]

.github/workflows/documentation.yml

@@ -10,6 +10,8 @@ on:
       - docs/**
   pull_request:
     types: [opened, reopened, synchronize]
+    paths:
+      - docs/**
 
 jobs:
   documentation:

.github/workflows/testing.yml

@@ -11,6 +11,8 @@ on:
       - docs/**
   pull_request:
     types: [opened, reopened, synchronize]
+    paths-ignore:
+      - docs/** 
 
 jobs:
   job_control:

docs/Contributors_Guide/add_use_case.rst

@@ -778,8 +778,6 @@ Embedding.
 Creating New Python Environments
 """"""""""""""""""""""""""""""""
 
-**COMING SOON!**
-
 In METplus v4.0.0 and earlier, a list of Python packages were added to use
 cases that required additional packages. These packages were either installed
 with pip3 or using a script. This approach was very time consuming as some
@@ -791,6 +789,8 @@ environments, refer to the comments in the scripts found in
 developer, so please contact MET Help if none of these environments contain the
 package requirements needed to run a new use case.
 
+**MORE INFO COMING SOON!**
+
 .. _add_new_category_to_test_runs:
 
 Add new category to test runs
@@ -802,23 +802,25 @@ In METplus version 4.0.0 and earlier, this list was
 found in the .github/workflows/testing.yml file.
 Add a new entry to the list that includes the category of the new use case,
 the list of indices that correspond to the index number described in the
-:ref:`add_use_case_to_test_suite` section,
-and set the "new" variable to true.
+:ref:`add_use_case_to_test_suite` section.
+Set the "run" variable to true so that the new use case group will run in
+the automated test suite whenever a new change is pushed to GitHub. This
+allows users to test that the new use case runs successfully.
 
 Example::
 
       {
         "category": "climate",
         "index_list": "2",
-        "new": true
+        "run": true
       }
 
 .. note::
     Make sure there is a comma after the curly braces for the item that comes
     before the new item in the list.
 
 This example adds a new use case group that contains the climate use case
-with index 2 and is marked as a "new" use case.
+with index 2 and is marked to "run" for every push.
 New use cases are added as a separate item to make reviewing the test results
 easier. A new use case will produce new output data that is not found in the
 "truth" data set which is compared the output of the use case runs to check
@@ -844,12 +846,12 @@ The argument supports a comma-separated list of numbers. Example::
       {
         "category": "data_assimilation",
         "index_list": "0,2,4",
-        "new": false
+        "run": false
       },
       {
         "category": "data_assimilation",
         "index_list": "1,3",
-        "new": false
+        "run": false
       },
 
 The above example will run a job with data_assimilation use cases 0, 2, and
@@ -860,12 +862,12 @@ It also supports a range of numbers separated with a dash. Example::
       {
         "category": "data_assimilation",
         "index_list": "0-3",
-        "new": false
+        "run": false
       },
       {
         "category": "data_assimilation",
         "index_list": "4-5",
-        "new": false
+        "run": false
       },
 
 The above example will run a job with data_assimilation 0, 1, 2, and 3, then
@@ -877,12 +879,12 @@ to run. Example::
       {
         "category": "data_assimilation",
         "index_list": "0-2,4",
-        "new": false
+        "run": false
       },
       {
         "category": "data_assimilation",
         "index_list": "3",
-        "new": false
+        "run": false
       },
 
 The above example will run data_assimilation 0, 1, 2, and 4 in one

docs/Contributors_Guide/continuous_integration.rst

@@ -120,7 +120,10 @@ Here is a list of the currently supported keywords and what they control:
 * **ci-skip-all**: Don't run anything - skip all automation jobs
 * **ci-skip-use-cases**: Don't run any use cases
 * **ci-run-all-cases**: Run all use cases
-* **ci-run-diff**: Obtain truth data and run diffing logic
+* **ci-run-diff**: Obtain truth data and run diffing logic for
+  use cases that are marked to run
+* **ci-run-all-diff**: Obtain truth data and run diffing logic for
+  all use cases
 * **ci-only-docs**: Only run build documentation job - skip the rest
 
 Force MET Version Used for Tests