Update develop-ref after dtcenter/MET#2849

.github/jobs/configure_sonarqube.sh

@@ -0,0 +1,65 @@
+#!/bin/bash
+
+# Constants
+SONAR_PROPERTIES_DIR=internal/scripts/sonarqube
+SONAR_PROPERTIES=sonar-project.properties
+
+# Check that this is being run from the top-level METplus directory
+if [ ! -e $SONAR_PROPERTIES_DIR/$SONAR_PROPERTIES ]; then
+  echo "ERROR: ${0} -> must be run from the top-level METplus directory"
+  exit 1
+fi
+
+# Check required environment variables
+if [ -z ${SOURCE_BRANCH+x} ]; then
+  echo "ERROR: ${0} -> \$SOURCE_BRANCH not defined!"
+  exit 1
+fi
+if [ -z ${WD_REFERENCE_BRANCH+x} ]; then
+  echo "ERROR: ${0} -> \$WD_REFERENCE_BRANCH not defined!"
+  exit 1
+fi
+if [ -z ${SONAR_HOST_URL+x} ]; then
+  echo "ERROR: ${0} -> \$SONAR_HOST_URL not defined!"
+  exit 1
+fi
+if [ -z ${SONAR_TOKEN+x} ]; then
+  echo "ERROR: ${0} -> \$SONAR_TOKEN not defined!"
+  exit 1
+fi
+
+# Define the version string
+SONAR_PROJECT_VERSION=$(cat metplus/VERSION)
+
+#
+# Define the $SONAR_REFERENCE_BRANCH as the
+#   - Target of any requests
+#   - Manual setting for workflow dispatch
+#   - Source branch for any pushes (e.g. develop)
+#
+if [ "$GITHUB_EVENT_NAME" == "pull_request" ]; then
+  export SONAR_REFERENCE_BRANCH=$GITHUB_BASE_REF
+elif [ "$GITHUB_EVENT_NAME" == "workflow_dispatch" ]; then
+  export SONAR_REFERENCE_BRANCH=$WD_REFERENCE_BRANCH
+else
+  export SONAR_REFERENCE_BRANCH=$SOURCE_BRANCH
+fi
+
+# Configure the sonar-project.properties
+[ -e $SONAR_PROPERTIES ] && rm $SONAR_PROPERTIES
+sed -e "s|SONAR_PROJECT_KEY|METplus-GHA|" \
+    -e "s|SONAR_PROJECT_NAME|METplus GHA|" \
+    -e "s|SONAR_PROJECT_VERSION|$SONAR_PROJECT_VERSION|" \
+    -e "s|SONAR_HOST_URL|$SONAR_HOST_URL|" \
+    -e "s|SONAR_TOKEN|$SONAR_TOKEN|" \
+    -e "s|SONAR_BRANCH_NAME|$SOURCE_BRANCH|" \
+    $SONAR_PROPERTIES_DIR/$SONAR_PROPERTIES > $SONAR_PROPERTIES
+
+# Define new code when the source and reference branches differ
+if [ "$SOURCE_BRANCH" != "$SONAR_REFERENCE_BRANCH" ]; then
+  echo "sonar.newCode.referenceBranch=${SONAR_REFERENCE_BRANCH}" >> $SONAR_PROPERTIES
+fi
+
+echo "Contents of the $SONAR_PROPERTIES file:"
+cat $SONAR_PROPERTIES
+

.github/jobs/get_use_cases_to_run.sh

@@ -18,10 +18,10 @@ 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 use cases that are marked to run every time (run = true)"
-    matrix=$(jq '[.[] | select(.run == true) | (.category + ":" + .index_list)]' $use_case_groups_filepath)
+    matrix=$(jq '[.[] | select(.run == true) | select(.disabled != true) | (.category + ":" + .index_list)]' $use_case_groups_filepath)
   else
     echo Add all available use cases
-    matrix=$(jq '[.[] | (.category + ":" + .index_list)]' $use_case_groups_filepath)
+    matrix=$(jq '[.[] | select(.disabled != true) | (.category + ":" + .index_list)]' $use_case_groups_filepath)
   fi
 
 fi

.github/parm/use_case_groups.json

@@ -267,6 +267,7 @@
   {
     "category": "short_range",
     "index_list": "14",
+    "disabled": true,
     "run": false
   },
   {

.github/pull_request_template.md

@@ -11,6 +11,9 @@
 - [ ] Will this PR result in changes to the test suite? **[Yes or No]**</br>
 If **yes**, describe the new output and/or changes to the existing output:</br>
 
+- [ ] Do these changes introduce new SonarQube findings? **[Yes or No]**</br>
+If **yes**, please describe:
+
 - [ ] Please complete this pull request review by **[Fill in date]**.</br>
 
 ## Pull Request Checklist ##

.github/workflows/sonarqube.yml

@@ -0,0 +1,82 @@
+name: SonarQube Scan
+
+# Run SonarQube for Pull Requests and changes to the develop and main_vX.Y branches
+
+on:
+
+  # Trigger analysis for pushes to develop and main_vX.Y branches
+  push:
+    branches:
+      - develop
+      - 'main_v**'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/pull_request_template.md'
+      - '.github/ISSUE_TEMPLATE/**'
+      - '.github/labels/**'
+      - 'build_components/**'
+      - 'manage_externals/**'
+      - '**/README.md'
+      - '**/LICENSE.md'
+
+  # Trigger analysis for pull requests to develop and main_vX.Y branches
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches:
+      - develop
+      - 'main_v**'
+    paths-ignore:
+      - 'docs/**'
+      - '.github/pull_request_template.md'
+      - '.github/ISSUE_TEMPLATE/**'
+      - '.github/labels/**'
+      - 'build_components/**'
+      - 'manage_externals/**'
+      - '**/README.md'
+      - '**/LICENSE.md'
+
+  workflow_dispatch:
+    inputs:
+      reference_branch:
+        description: 'Reference Branch'
+        default: develop
+        type: string
+
+jobs:
+  sonarqube:
+    name: SonarQube Scan
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - uses: actions/checkout@v4
+      with:
+        # Disable shallow clones for better analysis
+        fetch-depth: 0
+
+    - name: Get branch name
+      id: get_branch_name
+      run: echo branch_name=${GITHUB_REF#refs/heads/} >> $GITHUB_OUTPUT
+
+    - name: Configure SonarQube
+      run: .github/jobs/configure_sonarqube.sh
+      env:
+        SOURCE_BRANCH: ${{ steps.get_branch_name.outputs.branch_name }}
+        WD_REFERENCE_BRANCH: ${{ github.event.inputs.reference_branch }}
+        SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+
+    - name: SonarQube Scan
+      uses: sonarsource/sonarqube-scan-action@master
+      env:
+        SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+
+    - name: SonarQube Quality Gate check
+      id: sonarqube-quality-gate-check
+      uses: sonarsource/sonarqube-quality-gate-action@master
+      # Force to fail step after specific time.
+      timeout-minutes: 5
+      env:
+       SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+       SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

docs/Contributors_Guide/continuous_integration.rst

@@ -1191,6 +1191,31 @@ to run. Example::
 The above example will run data_assimilation 0, 1, 2, and 4 in one
 job, then data_assimilation 3 in another job.
 
+.. _cg-ci-disable_use_case:
+
+Disabling Use Cases
+"""""""""""""""""""
+
+Sometimes use cases should not run in the automated test suite.
+For example, changes to another repository may break a use case and prevent it
+from running successfully until a fix can be applied.
+In the meantime, to prevent the use case(s) from failing in the automated tests,
+a use case group can be disabled by adding *"disabled": true* in
+**use_case_groups.json**::
+
+      {
+        "category": "short_range",
+        "index_list": "14",
+        "disabled": true,
+        "run": true
+      },
+
+It is recommended to add this key/value pair before the *run* key/value to avoid
+having to add a comma to the end of the *run* value.
+
+If the *disabled* value is set to *true*, then the use case group will not run
+even if the *run* attribute is set to *true*.
+
 Run Use Cases
 ^^^^^^^^^^^^^
 

docs/Release_Guide/release_steps/update_release_notes_development.rst

@@ -26,8 +26,16 @@ release. Open the following URL in a browser:
 * If you are creating a beta1 release, remove the previous version's release
   notes, i.e. for 3.0.0-beta1, remove all 2.Y.Z notes and start a 3.0.0
   section with the format "Version X.Y.Z release notes (YYYYMMDD)".
-    
+
 * If you are creating a betaX release, add a new betaX section above the betaX-1
   release.
 
+* For the METplus repository, update the **development timeline**.
+
+  * If you are creating a beta1 release, add development timeline
+    information with approximate dates for planned development cycles.
+
+  * For other development releaes, edit the actual release dates and planned
+    release dates for future development cycles, as needed.
+
 * Commit changes and push to GitHub.

docs/Release_Guide/release_steps/update_release_notes_official.rst

@@ -20,10 +20,13 @@ release. Open the following URL in a browser:
   (e.g. Enhancements, Bugfixes, Documentation, etc.) and modifying
   GitHub issue titles for consistency. The release notes should match
   the GitHub issue titles, when possible.
-  
+
 * Use your best judgement to apply bold formatting for any major or important changes.
 
 * When creating the official release, combine the beta release sections
   into one section (i.e. "Version X.Y.Z release notes (YYYYMMDD)").
-
+
+* For the METplus repository, remove the **development timeline** information
+  prior to creating the official release.
+
 * Commit changes and push to GitHub.

docs/Users_Guide/release-notes.rst

@@ -4,10 +4,23 @@
 METplus Release Information
 ***************************
 
-Users can view the :ref:`releaseTypes` section of
-the Release Guide for descriptions of the development releases (including
-beta releases and release candidates), official releases, and bugfix
-releases for the METplus Components.
+Users can view the :ref:`releaseTypes` section of the Release Guide
+for descriptions of the development releases (including beta releases
+and release candidates), official releases, and bugfix releases for
+the METplus Components.
+
+.. _development_timeline:
+
+The **development timeline** for the METplus 6.0.0 Coordinated Release
+is broken down into the following development cycles for each component:
+
+1. **Beta1** releases for the METplus components occurred around 2023-09-15.
+2. **Beta2** releases for the METplus components occurred around 2023-11-14.
+3. **Beta3** releases for the METplus components occurred around 2024-02-08.
+4. **Beta4** releases are tentatively scheduled for 2024-04-17.
+5. **Beta5** releases are tentatively scheduled for 2024-06-26.
+6. **Release Candidate 1** releases have not yet been scheduled.
+7. **Official Release** releases have not yet been scheduled.
 
 .. _components-release-notes:
 

docs/requirements.txt

@@ -1,5 +1,5 @@
 sphinx==5.3.0
-pillow==10.2.0
+pillow==10.3.0
 sphinx-gallery==0.14.0
 sphinx-rtd-theme==1.3.0
 sphinx-design==0.3.0

internal/scripts/sonarqube/run_nightly.sh

@@ -20,8 +20,7 @@
 #=======================================================================
 
 # Constants
-#EMAIL_LIST="johnhg@ucar.edu hsoh@ucar.edu jpresto@ucar.edu linden@ucar.edu mccabe@ucar.edu"
-EMAIL_LIST="johnhg@ucar.edu hsoh@ucar.edu mccabe@ucar.edu"
+EMAIL_LIST="johnhg@ucar.edu hsoh@ucar.edu jpresto@ucar.edu mccabe@ucar.edu"
 KEEP_DAYS=5
 
 function usage {
@@ -39,7 +38,7 @@ SCRIPT_DIR=`dirname $0`
 if [[ ${0:0:1} != "/" ]]; then SCRIPT_DIR=$(pwd)/${SCRIPT_DIR}; fi 
 
 # Define the development environment
-ENV_FILE=${SCRIPT_DIR}/environment/development.`hostname`
+ENV_FILE=${SCRIPT_DIR}/development.`hostname`
 if [[ ! -e ${ENV_FILE} ]]; then
   echo "$0: ERROR -> Development environment file missing: ${ENV_FILE}"
   exit 1
@@ -71,6 +70,4 @@ if [[ $? -ne 0 ]]; then
   exit 1
 fi
 
-# Convert SonarQube report from pdf to html
-
 exit 0