From 31e0e443d4d60b1919e0cb6f0235b47ef4119e72 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 16 Jan 2025 14:35:33 -0700 Subject: [PATCH] Update develop-ref after dtcenter/MET#3036 (#2867) --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/jobs/free_disk_space.sh | 4 - .github/labels/common_labels.txt | 4 + .github/labels/delete_labels.sh | 6 +- .github/labels/get_labels.sh | 2 +- .github/labels/post_patch_labels.sh | 4 +- .github/labels/process_labels.sh | 2 +- .github/update_truth_change_log.txt | 1 + docs/Release_Guide/met_bugfix.rst | 1 - docs/Release_Guide/met_development.rst | 1 - docs/Release_Guide/met_official.rst | 1 - docs/Release_Guide/metcalcpy_bugfix.rst | 1 - docs/Release_Guide/metcalcpy_development.rst | 1 - docs/Release_Guide/metcalcpy_official.rst | 1 - docs/Release_Guide/metdataio_bugfix.rst | 1 - docs/Release_Guide/metdataio_development.rst | 3 +- docs/Release_Guide/metdataio_official.rst | 3 +- docs/Release_Guide/metexpress_official.rst | 1 - docs/Release_Guide/metplotpy_bugfix.rst | 1 - docs/Release_Guide/metplotpy_development.rst | 1 - docs/Release_Guide/metplotpy_official.rst | 1 - docs/Release_Guide/metplus_bugfix.rst | 3 +- docs/Release_Guide/metplus_development.rst | 3 +- docs/Release_Guide/metplus_official.rst | 5 +- docs/Release_Guide/metviewer_bugfix.rst | 3 +- docs/Release_Guide/metviewer_development.rst | 1 - docs/Release_Guide/metviewer_official.rst | 1 - .../release_steps/checkout_main_branch.rst | 10 +- .../release_steps/checkout_source_branch.rst | 22 +-- .../clone_project_repository.rst | 32 ++-- .../coordinated/announce_release.rst | 8 +- .../coordinated/update_zenodo.rst | 16 +- .../release_steps/create_release_branch.rst | 26 ++-- .../release_steps/create_release_extra.rst | 3 - .../create_release_feature_branch.rst | 14 +- .../create_release_on_github.rst | 44 +++--- .../release_steps/merge_release_issue.rst | 4 +- .../met/create_release_reference_branch.rst | 61 ++++---- .../met/update_tar_files_link_official.rst | 31 +++- .../met/update_version_bugfix.rst | 4 +- .../met/update_version_development.rst | 17 +- .../met/update_version_official.rst | 6 +- .../met/update_web_server_data.rst | 35 ++--- .../release_steps/met/update_zenodo.rst | 12 +- .../metcalcpy/update_version_bugfix.rst | 4 +- .../metcalcpy/update_version_development.rst | 16 +- .../metcalcpy/update_version_official.rst | 7 +- .../metcalcpy/update_version_on_develop.rst | 33 ++-- .../metdataio/update_version_bugfix.rst | 4 +- .../metdataio/update_version_development.rst | 18 ++- .../metdataio/update_version_official.rst | 8 +- .../metdataio/update_version_on_develop.rst | 33 ++-- .../metexpress/announce_release.rst | 10 +- .../checkout_development_branch.rst | 8 +- ...checkout_development_branch_submodules.rst | 29 ++-- .../metexpress/checkout_main_branch.rst | 29 ++-- .../metexpress/clone_project_repository.rst | 33 ++-- .../create_development_feature_branch.rst | 12 +- .../metexpress/deploy_AWS_apps.rst | 26 ---- .../metexpress/deploy_beta_apps.rst | 32 ++-- .../metexpress/deploy_production_apps.rst | 30 ++-- .../metexpress/merge_development_to_main.rst | 33 ++-- .../metexpress/merge_feature_branch.rst | 2 +- .../pull_changes_and_merge_to_dev.rst | 113 +++++++------- .../metexpress/tag_app_version_and_build.rst | 32 ++-- .../metexpress/update_dates_and_versions.rst | 24 +-- .../metplotpy/update_version_bugfix.rst | 5 +- .../metplotpy/update_version_development.rst | 14 +- .../metplotpy/update_version_official.rst | 5 +- .../metplotpy/update_version_on_develop.rst | 33 ++-- .../metplus/add_next_version_to_lookup.rst | 58 +++---- .../coordinated_release_announcement.rst | 12 +- .../metplus/create_release_extra.rst | 9 -- .../metplus/create_release_on_github.rst | 42 +++++ .../create_release_reference_branch.rst | 115 +++++++------- .../metplus/update_development_timeline.rst | 26 ++-- .../metplus/update_existing_builds_docker.rst | 24 +-- .../metplus/update_release_date.rst | 8 +- .../metplus/update_version_bugfix.rst | 7 +- .../metplus/update_version_official.rst | 8 +- .../metplus/update_version_on_develop.rst | 34 ++-- .../metplus/update_web_server_data.rst | 5 +- .../metviewer/update_version_bugfix.rst | 4 +- .../metviewer/update_version_development.rst | 22 +-- .../metviewer/update_version_official.rst | 5 +- .../metviewer/update_version_on_develop.rst | 33 ++-- .../release_steps/open_release_issue.rst | 16 +- .../release_steps/rotate_authorship.rst | 46 +++--- .../set_beta_deletion_reminder_official.rst | 28 ++-- .../release_steps/update_docs_official.rst | 40 ++--- .../update_release_notes_bugfix.rst | 56 +++---- .../update_release_notes_development.rst | 44 +++--- .../update_release_notes_official.rst | 44 +++--- .../update_upgrade_instructions.rst | 36 +++-- docs/Users_Guide/glossary.rst | 25 +++ docs/Users_Guide/overview.rst | 2 +- docs/Users_Guide/wrappers.rst | 35 +++++ docs/_static/pop_ver.js | 18 --- docs/build_docs.py | 13 +- docs/conf.py | 2 +- .../s2s_mjo/UserScript_obsERA_obsOnly_RMM.py | 2 +- .../compile_official_release_notes.py | 4 +- internal/scripts/docker/Dockerfile | 6 +- internal/tests/pytests/conftest.py | 2 +- .../config_metplus/test_config_metplus.py | 31 ++-- .../util/config_util/test_config_util.py | 15 +- .../pytests/util/diff_util/test_diff_util.py | 12 +- .../util/met_config/test_met_config.py | 147 +++++++++--------- .../pytests/util/run_util/test_run_util.py | 33 ++-- .../grid_stat/test_grid_stat_wrapper.py | 9 ++ .../series_analysis/test_series_analysis.py | 18 ++- metplus/wrappers/grid_stat_wrapper.py | 6 + metplus/wrappers/series_analysis_wrapper.py | 7 + parm/met_config/GridStatConfig_wrapped | 6 +- parm/met_config/SeriesAnalysisConfig_wrapped | 9 ++ .../met_tool_wrapper/GridStat/GridStat.conf | 3 + .../SeriesAnalysis/SeriesAnalysis.conf | 4 + 117 files changed, 1198 insertions(+), 929 deletions(-) delete mode 100644 docs/Release_Guide/release_steps/create_release_extra.rst delete mode 100644 docs/Release_Guide/release_steps/metexpress/deploy_AWS_apps.rst delete mode 100644 docs/Release_Guide/release_steps/metplus/create_release_extra.rst create mode 100644 docs/Release_Guide/release_steps/metplus/create_release_on_github.rst delete mode 100644 docs/_static/pop_ver.js diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 3e8ad837b1..f652d5b74a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -28,7 +28,7 @@ Describe the steps to reproduce the behavior: *3. Scroll down to '....'* *4. See error* *Post relevant sample data following these instructions:* -*https://dtcenter.org/community-code/model-evaluation-tools-met/met-help-desk#ftp* +*https://github.com/dtcenter/METplus/discussions/954* ### Relevant Deadlines ### *List relevant project deadlines here or state NONE.* diff --git a/.github/jobs/free_disk_space.sh b/.github/jobs/free_disk_space.sh index fc6c6bad0b..f4f86e8a7c 100755 --- a/.github/jobs/free_disk_space.sh +++ b/.github/jobs/free_disk_space.sh @@ -59,10 +59,6 @@ cmd="docker image prune -af" printf "\nRunning $cmd" $cmd -cmd=docker system prune -af -printf "\nRunning $cmd" -$cmd - cmd="docker images" printf "\nAFTER CLEANUP: $cmd" $cmd diff --git a/.github/labels/common_labels.txt b/.github/labels/common_labels.txt index 4ed7ffa623..269a9cdab3 100644 --- a/.github/labels/common_labels.txt +++ b/.github/labels/common_labels.txt @@ -13,6 +13,8 @@ {"name": "component: testing","color": "1d76db","description": "Software testing issue"} {"name": "component: training","color": "1d76db","description": "Training issue"} {"name": "component: user support","color": "1d76db","description": "User support issue"} +{"name": "pull request: MODIFIES CONFIG","color": "c2e0c6","description": "Changes that add new or modify existing configuration options"} +{"name": "pull request: MODIFIES OUTPUT","color": "c2e0c6","description": "Changes that add new or modify existing output formats"} {"name": "priority: blocker","color": "b60205","description": "Blocker"} {"name": "priority: high","color": "ed2939","description": "High Priority"} {"name": "priority: low","color": "cce88d","description": "Low Priority"} @@ -20,6 +22,7 @@ {"name": "priority: bold for release notes","color": "ededed","description": "Issue should be bolded in release notes"} {"name": "reporting: DTC AF METplus","color": "fbca04","description": "Air Force METplus Project"} {"name": "reporting: DTC NCAR Base","color": "fbca04","description": "NCAR Base DTC Project"} +{"name": "reporting: DTC NOAA BASE","color": "fbca04","description": "NOAA Office of Atmospheric Research DTC Project"} {"name": "reporting: DTC NOAA OAR","color": "fbca04","description": "NOAA Office of Atmospheric Research DTC Project"} {"name": "reporting: DTC NOAA R2O","color": "fbca04","description": "NOAA Research to Operations DTC Project"} {"name": "reporting: HSUP 1-3a","color": "fbca04","description": "Hurricane Supplemental Project 1-3a"} @@ -49,6 +52,7 @@ {"name": "requestor: NOAA/MDL","color": "3101c1","description": "NOAA Meteorological Development Laboratory"} {"name": "requestor: NOAA/NHC","color": "3101c1","description": "NOAA National Hurricane Center"} {"name": "requestor: NOAA/NSSL","color": "3101c1","description": "NOAA National Severe Storms Laboratory"} +{"name": "requestor: NOAA/NWS","color": "3101c1","description": "NOAA National Weather Service"} {"name": "requestor: NOAA/OPC","color": "3101c1","description": "NOAA Ocean Prediction Center"} {"name": "requestor: NOAA/other","color": "3101c1","description": "NOAA Laboratory, not otherwise specified"} {"name": "requestor: NOAA/PSD","color": "3101c1","description": "NOAA Physical Sciences Laboratory"} diff --git a/.github/labels/delete_labels.sh b/.github/labels/delete_labels.sh index 479f28d3b6..053c6e7e91 100755 --- a/.github/labels/delete_labels.sh +++ b/.github/labels/delete_labels.sh @@ -1,4 +1,4 @@ -#!/bin/sh +#!/bin/bash # Must specify 3 arguments: # - username @@ -23,7 +23,7 @@ COMMON_LABELS="`dirname $0`/common_labels.txt" # Output command file CMD_FILE="`dirname $0`/commands/delete_labels_${repo}_cmd.sh" -echo "#!/bin/sh -v" > ${CMD_FILE} +echo "#!/bin/bash -v" > ${CMD_FILE} # Get the current repo labels SCRIPT_DIR=`dirname $0` @@ -47,7 +47,7 @@ while read -r line; do is_common=`egrep -i "\"${name}\"" ${COMMON_LABELS} | wc -l` # Check if its a custom label that beginning with component, type, or repository name - is_custom=`echo ${name} | egrep -r -i "component:|type:|${repo}" | wc -l` + is_custom=`echo ${name} | egrep -i "component:|type:|^MET" | wc -l` # Keep COMMON labels if [[ $is_common -gt 0 ]]; then diff --git a/.github/labels/get_labels.sh b/.github/labels/get_labels.sh index a4fb0844d3..60693b7cdb 100755 --- a/.github/labels/get_labels.sh +++ b/.github/labels/get_labels.sh @@ -1,4 +1,4 @@ -#!/bin/sh +#!/bin/bash # Must specify 3 arguments: # - username diff --git a/.github/labels/post_patch_labels.sh b/.github/labels/post_patch_labels.sh index 5d5ee3a36d..d04ed1e944 100755 --- a/.github/labels/post_patch_labels.sh +++ b/.github/labels/post_patch_labels.sh @@ -24,10 +24,10 @@ URL="https://api.github.com/repos/dtcenter/${repo}/labels" # Output command files POST_CMD_FILE="`dirname $0`/commands/post_labels_${repo}_cmd.sh" -echo "#!/bin/sh -v" > ${POST_CMD_FILE} +echo "#!/bin/bash -v" > ${POST_CMD_FILE} PATCH_CMD_FILE="`dirname $0`/commands/patch_labels_${repo}_cmd.sh" -echo "#!/bin/sh -v" > ${PATCH_CMD_FILE} +echo "#!/bin/bash -v" > ${PATCH_CMD_FILE} # Initialize counts n_post=0 diff --git a/.github/labels/process_labels.sh b/.github/labels/process_labels.sh index a75b8675a4..d483346c7c 100755 --- a/.github/labels/process_labels.sh +++ b/.github/labels/process_labels.sh @@ -1,4 +1,4 @@ -#!/bin/sh +#!/bin/bash # Must specify 2 arguments: # - username diff --git a/.github/update_truth_change_log.txt b/.github/update_truth_change_log.txt index 129658b9de..8edd8f9b36 100644 --- a/.github/update_truth_change_log.txt +++ b/.github/update_truth_change_log.txt @@ -15,3 +15,4 @@ [20241203_22:42:18 develop] dtcenter/MET#3008 - Adds new units attribute to Gen-Vx-Mask output [$(date +%Y%m%d_%H:%M:%S) ${branch_name}] #2836 - #2836 modified a use case to sort files to produce consistent results for each run [$(date +%Y%m%d_%H:%M:%S) ${branch_name}] #2817 - #2817 changed the output file name for the s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking use case +[$(date +%Y%m%d_%H:%M:%S) ${branch_name}] dtcenter/MET#3036 - dtcenter/MET#3036 adds new columns diff --git a/docs/Release_Guide/met_bugfix.rst b/docs/Release_Guide/met_bugfix.rst index d70e91427e..fc06fdd1b2 100644 --- a/docs/Release_Guide/met_bugfix.rst +++ b/docs/Release_Guide/met_bugfix.rst @@ -13,7 +13,6 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch. .. include:: release_steps/update_release_notes_bugfix.rst .. include:: release_steps/merge_release_issue.rst .. 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/met_development.rst b/docs/Release_Guide/met_development.rst index 57f627d498..66afc50549 100644 --- a/docs/Release_Guide/met_development.rst +++ b/docs/Release_Guide/met_development.rst @@ -17,7 +17,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. 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 .. include:: release_steps/finalize_release_on_github_development.rst .. include:: release_steps/release_acceptance_testing.rst diff --git a/docs/Release_Guide/met_official.rst b/docs/Release_Guide/met_official.rst index a800161443..b694b41fba 100644 --- a/docs/Release_Guide/met_official.rst +++ b/docs/Release_Guide/met_official.rst @@ -15,7 +15,6 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/rotate_authorship.rst .. include:: release_steps/merge_release_issue.rst .. 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/finalize_release_on_github_official.rst .. include:: release_steps/met/update_tar_files_link_official.rst diff --git a/docs/Release_Guide/metcalcpy_bugfix.rst b/docs/Release_Guide/metcalcpy_bugfix.rst index 62d6ade67e..10b06c6230 100644 --- a/docs/Release_Guide/metcalcpy_bugfix.rst +++ b/docs/Release_Guide/metcalcpy_bugfix.rst @@ -13,7 +13,6 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch. .. include:: release_steps/update_release_notes_bugfix.rst .. include:: release_steps/merge_release_issue.rst .. 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/metcalcpy_development.rst b/docs/Release_Guide/metcalcpy_development.rst index a70a26311c..648be82da9 100644 --- a/docs/Release_Guide/metcalcpy_development.rst +++ b/docs/Release_Guide/metcalcpy_development.rst @@ -15,7 +15,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. 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 .. include:: release_steps/finalize_release_on_github_development.rst .. include:: release_steps/release_acceptance_testing.rst diff --git a/docs/Release_Guide/metcalcpy_official.rst b/docs/Release_Guide/metcalcpy_official.rst index cc1d8b51c6..40e11cdb41 100644 --- a/docs/Release_Guide/metcalcpy_official.rst +++ b/docs/Release_Guide/metcalcpy_official.rst @@ -15,7 +15,6 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/rotate_authorship.rst .. include:: release_steps/merge_release_issue.rst .. 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/finalize_release_on_github_official.rst .. include:: release_steps/metcalcpy/update_version_on_develop.rst diff --git a/docs/Release_Guide/metdataio_bugfix.rst b/docs/Release_Guide/metdataio_bugfix.rst index 992e44b48f..19cefe6c92 100644 --- a/docs/Release_Guide/metdataio_bugfix.rst +++ b/docs/Release_Guide/metdataio_bugfix.rst @@ -16,7 +16,6 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch. .. include:: release_steps/update_release_notes_bugfix.rst .. include:: release_steps/merge_release_issue.rst .. 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/metdataio_development.rst b/docs/Release_Guide/metdataio_development.rst index 33bc526a24..0559a3eccb 100644 --- a/docs/Release_Guide/metdataio_development.rst +++ b/docs/Release_Guide/metdataio_development.rst @@ -5,7 +5,7 @@ METdataio Development Release .. |projectName| replace:: |projectRepo| .. |addTarfileStep| replace:: Link text should be the name of the release and the URL should be the release page that was just created under the GitHub Releases tab. .. |otherWebsiteUpdates| replace:: Make any other necessary website updates. - + Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop branch while working toward an official vX.Y.Z release. .. include:: release_steps/open_release_issue.rst @@ -18,7 +18,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. 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 .. include:: release_steps/finalize_release_on_github_development.rst .. include:: release_steps/release_acceptance_testing.rst diff --git a/docs/Release_Guide/metdataio_official.rst b/docs/Release_Guide/metdataio_official.rst index b53b87729a..82a71884a3 100644 --- a/docs/Release_Guide/metdataio_official.rst +++ b/docs/Release_Guide/metdataio_official.rst @@ -5,7 +5,7 @@ METdataio Official Release .. |projectName| replace:: |projectRepo| .. |addTarfileStep| replace:: Link text should be the name of the release and the URL should be the release page that was just created under the GitHub Releases tab. .. |otherWebsiteUpdates| replace:: Make any other necessary website updates. - + Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/open_release_issue.rst @@ -18,7 +18,6 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/rotate_authorship.rst .. include:: release_steps/merge_release_issue.rst .. 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/finalize_release_on_github_official.rst .. include:: release_steps/metdataio/update_version_on_develop.rst diff --git a/docs/Release_Guide/metexpress_official.rst b/docs/Release_Guide/metexpress_official.rst index 20cfcc1520..b41f497420 100644 --- a/docs/Release_Guide/metexpress_official.rst +++ b/docs/Release_Guide/metexpress_official.rst @@ -14,7 +14,6 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/metexpress/tag_app_version_and_build.rst .. include:: release_steps/metexpress/deploy_beta_apps.rst .. include:: release_steps/metexpress/deploy_production_apps.rst -.. include:: release_steps/metexpress/deploy_AWS_apps.rst .. 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 diff --git a/docs/Release_Guide/metplotpy_bugfix.rst b/docs/Release_Guide/metplotpy_bugfix.rst index f9609dcdec..3dc1419b62 100644 --- a/docs/Release_Guide/metplotpy_bugfix.rst +++ b/docs/Release_Guide/metplotpy_bugfix.rst @@ -12,7 +12,6 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch. .. include:: release_steps/update_release_notes_bugfix.rst .. include:: release_steps/merge_release_issue.rst .. 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/metplotpy_development.rst b/docs/Release_Guide/metplotpy_development.rst index e8aa8a864f..3394248ff0 100644 --- a/docs/Release_Guide/metplotpy_development.rst +++ b/docs/Release_Guide/metplotpy_development.rst @@ -15,7 +15,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. 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 .. include:: release_steps/finalize_release_on_github_development.rst .. include:: release_steps/release_acceptance_testing.rst diff --git a/docs/Release_Guide/metplotpy_official.rst b/docs/Release_Guide/metplotpy_official.rst index 47d97cc131..7336dbec8a 100644 --- a/docs/Release_Guide/metplotpy_official.rst +++ b/docs/Release_Guide/metplotpy_official.rst @@ -15,7 +15,6 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/rotate_authorship.rst .. include:: release_steps/merge_release_issue.rst .. 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/finalize_release_on_github_official.rst .. include:: release_steps/metplotpy/update_version_official.rst diff --git a/docs/Release_Guide/metplus_bugfix.rst b/docs/Release_Guide/metplus_bugfix.rst index 2d04b8c2cd..414459a84f 100644 --- a/docs/Release_Guide/metplus_bugfix.rst +++ b/docs/Release_Guide/metplus_bugfix.rst @@ -13,8 +13,7 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch. .. include:: release_steps/update_release_notes_bugfix.rst .. include:: release_steps/metplus/update_existing_builds_docker.rst .. include:: release_steps/merge_release_issue.rst -.. include:: release_steps/create_release_on_github.rst -.. include:: release_steps/metplus/create_release_extra.rst +.. include:: release_steps/metplus/create_release_on_github.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_development.rst b/docs/Release_Guide/metplus_development.rst index fd8cc4aa98..5f3350402b 100644 --- a/docs/Release_Guide/metplus_development.rst +++ b/docs/Release_Guide/metplus_development.rst @@ -16,8 +16,7 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/metplus/update_existing_builds_docker.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/create_release_on_github.rst .. include:: release_steps/metplus/update_version_on_develop.rst .. include:: release_steps/metplus/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_development.rst diff --git a/docs/Release_Guide/metplus_official.rst b/docs/Release_Guide/metplus_official.rst index c09ce003c9..9a17481839 100644 --- a/docs/Release_Guide/metplus_official.rst +++ b/docs/Release_Guide/metplus_official.rst @@ -4,7 +4,7 @@ METplus Official Release .. |projectRepo| replace:: METplus 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_main_branch.rst @@ -17,8 +17,7 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/rotate_authorship.rst .. include:: release_steps/metplus/update_existing_builds_docker.rst .. include:: release_steps/merge_release_issue.rst -.. include:: release_steps/create_release_on_github.rst -.. include:: release_steps/metplus/create_release_extra.rst +.. include:: release_steps/metplus/create_release_on_github.rst .. include:: release_steps/metplus/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_official.rst .. include:: release_steps/update_docs_official.rst diff --git a/docs/Release_Guide/metviewer_bugfix.rst b/docs/Release_Guide/metviewer_bugfix.rst index 39a1705a00..fe38fd2efe 100644 --- a/docs/Release_Guide/metviewer_bugfix.rst +++ b/docs/Release_Guide/metviewer_bugfix.rst @@ -5,7 +5,7 @@ METviewer Bugfix Release Create a new vX.Y.Z bugfix release from the main_vX.Y branch. -.. include:: release_steps/open_release_issue.rst +.. include:: release_steps/open_release_issue.rst .. include:: release_steps/clone_project_repository.rst .. include:: release_steps/checkout_main_branch.rst .. include:: release_steps/create_release_feature_branch.rst @@ -13,7 +13,6 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch. .. include:: release_steps/update_release_notes_bugfix.rst .. include:: release_steps/merge_release_issue.rst .. 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/metviewer_development.rst b/docs/Release_Guide/metviewer_development.rst index 6f0d07b5c7..72e0d7ede4 100644 --- a/docs/Release_Guide/metviewer_development.rst +++ b/docs/Release_Guide/metviewer_development.rst @@ -15,7 +15,6 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. 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 .. include:: release_steps/finalize_release_on_github_development.rst .. include:: release_steps/release_acceptance_testing.rst diff --git a/docs/Release_Guide/metviewer_official.rst b/docs/Release_Guide/metviewer_official.rst index a0dbdf45ce..200757315c 100644 --- a/docs/Release_Guide/metviewer_official.rst +++ b/docs/Release_Guide/metviewer_official.rst @@ -15,7 +15,6 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/rotate_authorship.rst .. include:: release_steps/merge_release_issue.rst .. 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/finalize_release_on_github_official.rst .. include:: release_steps/metviewer/update_version_on_develop.rst diff --git a/docs/Release_Guide/release_steps/checkout_main_branch.rst b/docs/Release_Guide/release_steps/checkout_main_branch.rst index 830c96d30a..fe9524cdd4 100644 --- a/docs/Release_Guide/release_steps/checkout_main_branch.rst +++ b/docs/Release_Guide/release_steps/checkout_main_branch.rst @@ -1,9 +1,11 @@ Checkout the Main Branch ^^^^^^^^^^^^^^^^^^^^^^^^ -Checkout the main branch for the X.Y release. If you are creating -the |projectRepo|-X.Y.Z official or bugfix release, checkout main_vX.Y. +.. dropdown:: Instructions -.. parsed-literal:: + Checkout the main branch for the X.Y release. If you are creating + the |projectRepo|-X.Y.Z official or bugfix release, checkout main_vX.Y. - git checkout main_vX.Y + .. parsed-literal:: + + git checkout main_vX.Y diff --git a/docs/Release_Guide/release_steps/checkout_source_branch.rst b/docs/Release_Guide/release_steps/checkout_source_branch.rst index 094a8029fd..da5507ea4b 100644 --- a/docs/Release_Guide/release_steps/checkout_source_branch.rst +++ b/docs/Release_Guide/release_steps/checkout_source_branch.rst @@ -1,18 +1,22 @@ Checkout the Source Branch ^^^^^^^^^^^^^^^^^^^^^^^^^^ -* If creating a **beta** (betaN) or **first release candidate** (rc1) release, - checkout the develop branch: +Checkout the source branch based on the type of release to be created. -.. parsed-literal:: +.. dropdown:: If creating a beta or rc1 release - git checkout develop + * If creating a **beta** (betaN) or **first release candidate** (rc1) release, + checkout the develop branch: -**OR** + .. parsed-literal:: -* If creating a **later release candidate** (rc2+) release, - checkout the appropriate main branch: + git checkout develop -.. parsed-literal:: +.. dropdown:: If creating an rc2+ release - git checkout main_vX.Y + * 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/clone_project_repository.rst b/docs/Release_Guide/release_steps/clone_project_repository.rst index 1003da4f57..574b110d05 100644 --- a/docs/Release_Guide/release_steps/clone_project_repository.rst +++ b/docs/Release_Guide/release_steps/clone_project_repository.rst @@ -1,30 +1,34 @@ Clone the Project Repository ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* Create and work in a new directory to ensure a fresh environment: +Clone the repository onto your local machine. -.. parsed-literal:: +.. dropdown:: Instructions - mkdir release-X.Y.Z - cd release-X.Y.Z + * Create and work in a new directory to ensure a fresh environment: -* Run the clone command to obtain the repository. + .. parsed-literal:: -Using SSH: + mkdir release-X.Y.Z + cd release-X.Y.Z -.. parsed-literal:: + * Run the clone command to obtain the repository. - git clone git@github.com:dtcenter/|projectRepo| + Using SSH: -Using HTTP: + .. parsed-literal:: -.. parsed-literal:: + git clone git@github.com:dtcenter/|projectRepo| - git clone https://github.com/dtcenter/|projectRepo| + Using HTTP: -* Enter the project repository directory: + .. parsed-literal:: -.. parsed-literal:: + git clone https://github.com/dtcenter/|projectRepo| - cd |projectRepo| + * Enter the project repository directory: + + .. parsed-literal:: + + cd |projectRepo| diff --git a/docs/Release_Guide/release_steps/coordinated/announce_release.rst b/docs/Release_Guide/release_steps/coordinated/announce_release.rst index 9a29d68c9e..d23e4f0328 100644 --- a/docs/Release_Guide/release_steps/coordinated/announce_release.rst +++ b/docs/Release_Guide/release_steps/coordinated/announce_release.rst @@ -1,6 +1,10 @@ Announce Release ---------------- -* Contact the METplus project manager to announce the coordinated release via email. +Let users know about this new coordinated release. -* Contact the RAL-IT group to request that the coordinated release components be installed in */usr/local* to be used on all RAL machines. +.. dropdown:: Instructions + + * Contact the METplus project manager to announce the coordinated release via email. + + * Contact the RAL-IT group to request that the coordinated release components be installed in */usr/local* to be used on all RAL machines. diff --git a/docs/Release_Guide/release_steps/coordinated/update_zenodo.rst b/docs/Release_Guide/release_steps/coordinated/update_zenodo.rst index 2dd71a2c22..c483545f0a 100644 --- a/docs/Release_Guide/release_steps/coordinated/update_zenodo.rst +++ b/docs/Release_Guide/release_steps/coordinated/update_zenodo.rst @@ -1,9 +1,13 @@ Update Zenodo ------------- -In the `METplus GitHub repository `_ -scroll down to the README file and check the -`METplus Coordinated Release Digital Object Identifier (DOI) `_ -on Zenodo. Once all METplus components have been released, gather the zip files -for each METplus component release in the METplus Verification System -Coordinated Release and upload them to create a new version on Zenodo. +Update the DOI for this coordinated release. + +.. dropdown:: Instructions + + In the `METplus GitHub repository `_ + scroll down to the README file and check the + `METplus Coordinated Release Digital Object Identifier (DOI) `_ + on Zenodo. Once all METplus components have been released, gather the zip files + for each METplus component release in the METplus Verification System + Coordinated Release and upload them to create a new version on Zenodo. diff --git a/docs/Release_Guide/release_steps/create_release_branch.rst b/docs/Release_Guide/release_steps/create_release_branch.rst index bb92aaa1ff..4df6932552 100644 --- a/docs/Release_Guide/release_steps/create_release_branch.rst +++ b/docs/Release_Guide/release_steps/create_release_branch.rst @@ -1,22 +1,22 @@ Create Release Branch ^^^^^^^^^^^^^^^^^^^^^ -.. note:: +For rc1 development releases, create a new main branch for the upcoming official release. - 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. +.. dropdown:: If creating an rc1 release + * 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. -* 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:: -.. parsed-literal:: + cd |projectRepo| + git checkout develop + git pull + git checkout -b main_vX.Y + git push -u origin main_vX.Y - cd |projectRepo| - git checkout develop - git pull - git checkout -b main_vX.Y - git push -u origin main_vX.Y +.. dropdown:: If creating a betaN or rc2+ release + Continue to the next instruction. diff --git a/docs/Release_Guide/release_steps/create_release_extra.rst b/docs/Release_Guide/release_steps/create_release_extra.rst deleted file mode 100644 index 51830cdcce..0000000000 --- a/docs/Release_Guide/release_steps/create_release_extra.rst +++ /dev/null @@ -1,3 +0,0 @@ -* If this is a development release, check the box that says "This is a pre-release". - -* Click on "Publish release". diff --git a/docs/Release_Guide/release_steps/create_release_feature_branch.rst b/docs/Release_Guide/release_steps/create_release_feature_branch.rst index 5d44877dc6..c14feaf2db 100644 --- a/docs/Release_Guide/release_steps/create_release_feature_branch.rst +++ b/docs/Release_Guide/release_steps/create_release_feature_branch.rst @@ -1,10 +1,14 @@ Create Release Feature Branch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* Create a feature branch in which to update the version number and add release notes being sure to include the GitHub issue number for the new release. +Create a feature branch to update the version number and add release notes. -.. parsed-literal:: +.. dropdown:: Instructions - git checkout -b feature_NNNN_vX.Y.Z # for an official or bugfix release - git checkout -b feature_NNNN_vX.Y.Z-betaN # for a development release - git checkout -b feature_NNNN_vX.Y.Z-rcN # for a development release + * Include the GitHub issue number in the feature branch for the new release. + + .. parsed-literal:: + + git checkout -b feature_NNNN_vX.Y.Z # for an official or bugfix release + git checkout -b feature_NNNN_vX.Y.Z-betaN # for a development release + git checkout -b feature_NNNN_vX.Y.Z-rcN # for a development release diff --git a/docs/Release_Guide/release_steps/create_release_on_github.rst b/docs/Release_Guide/release_steps/create_release_on_github.rst index efbbbb76a8..f8b9f1478c 100644 --- a/docs/Release_Guide/release_steps/create_release_on_github.rst +++ b/docs/Release_Guide/release_steps/create_release_on_github.rst @@ -1,29 +1,37 @@ Create Release on GitHub ^^^^^^^^^^^^^^^^^^^^^^^^ -* Ensure that any and all dependent releases for |projectRepo| - have been created according to :ref:`releaseDependencies`. +Create the new release on GitHub. -* Go to Releases on GitHub and click 'Draft a new release' +.. dropdown:: Instructions -* 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) + * Ensure that any and all dependent releases for |projectRepo| + have been created according to :ref:`releaseDependencies`. -* Define the 'Target' branch as: + * Go to Releases on GitHub and click 'Draft a new release' - * 'develop' for a beta development release + * 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) - * 'main_vX.Y' for a release candidate, bugfix, or official release + * Define the 'Target' branch as: -* 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) + * 'develop' for a beta development release -* 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 - (Note: the URL will not be active until the release is created) - Refer to a previous release to easily copy and modify this information. + * 'main_vX.Y' for a release candidate, bugfix, or official release -* 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) - Refer to a previous release to easily copy and modify this information. + * 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 + (Note: the URL will not be active until the release is created) + Refer to a previous release to easily copy and modify this information. + + * 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) + Refer to a previous release to easily copy and modify this information. + + * If this is a development release, check the box that says "This is a pre-release". + + * Click on "Publish release". diff --git a/docs/Release_Guide/release_steps/merge_release_issue.rst b/docs/Release_Guide/release_steps/merge_release_issue.rst index 6b9ec261bf..ae73799fcc 100644 --- a/docs/Release_Guide/release_steps/merge_release_issue.rst +++ b/docs/Release_Guide/release_steps/merge_release_issue.rst @@ -1,5 +1,5 @@ Merge Release Issue ^^^^^^^^^^^^^^^^^^^ -* After updating the release-specific content on a release feature branch, - submit a pull request to merge those changes back into the source branch. +After updating the release-specific content on a release feature branch, +submit a pull request to merge those changes back into the source branch. 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 index 9477c31557..e10af08dd3 100644 --- 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,44 +1,45 @@ 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. +For rc1 development releases, create a new reference branch for the upcoming official release. +.. dropdown:: If creating an rc1 release -* 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. + * 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:: + .. parsed-literal:: - cd |projectRepo| - git checkout develop - git pull - git checkout -b main_vX.Y-ref + cd |projectRepo| + git checkout develop + git pull + git checkout -b main_vX.Y-ref -Push Reference Branch to GitHub -""""""""""""""""""""""""""""""" + * Push Reference Branch to GitHub -:: + .. parsed-literal:: - git push -u origin main_vX.Y-ref + git push -u origin main_vX.Y-ref -Pushing this branch to GitHub may trigger the GitHub Actions testing workflow -to run all of the use cases and create a 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. If the workflow was -not automatically triggered, use the GitHub workflow dispatch option to manually -run the **Testing** workflow for the 'main_vX.Y-ref' branch. + * Pushing this branch to GitHub may trigger the GitHub Actions testing workflow + to run all of the use cases and create a 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 -""""""""""""""""""""""""""""""" + * If the workflow was not automatically triggered, use the GitHub workflow + dispatch option to manually run the **Testing** workflow for the 'main_vX.Y-ref' + branch. -Navigate to https://github.com/dtcenter/MET/actions and verify that a -'Testing' workflow was triggered on the 'main_vX.Y-ref' branch. + * Monitor GitHub Actions Workflow -* 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). + * 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). + +.. dropdown:: If creating a betaN or rc2+ release + + Continue to the next instruction. diff --git a/docs/Release_Guide/release_steps/met/update_tar_files_link_official.rst b/docs/Release_Guide/release_steps/met/update_tar_files_link_official.rst index 34a1083cfe..3f1eac9f04 100644 --- a/docs/Release_Guide/release_steps/met/update_tar_files_link_official.rst +++ b/docs/Release_Guide/release_steps/met/update_tar_files_link_official.rst @@ -1,8 +1,31 @@ -Update tar_files Link +Update Tar File Links ^^^^^^^^^^^^^^^^^^^^^ -On the DTC web server machine (i.e. mohawk), in /d2/www/dtcenter/dfiles/code/METplus/MET/installation/, update -the link for tar_files.latest.tgz, to point to the latest version of the -tar_files.met-base-vX.Y.tgz file (viewable at https://dtcenter.ucar.edu/dfiles/code/METplus/MET/installation/). +Tar files containing the source code for the libraries upon which MET depends are provided on the DTC website. +Update the tar file links for each official release. +.. dropdown:: Instructions + - On the DTC web server machine (i.e. mohawk) navigate to installation directory as the met_test user. + + .. parsed-literal:: + + runas met_test + cd /d2/www/dtcenter/dfiles/code/METplus/MET/installation + + - Add a link for the newly created MET release to the METbaseimage version upon which it depends. + + .. parsed-literal:: + + # Replace "A.B" with the METbaseimage version + # upon which the MET "X.Y" version depends + ln -sf tar_files.met-base.vA.B.tgz tar_files.met-vX.Y.tgz + + - Update the "latest" link for the newly created MET "X.Y" version. + + .. parsed-literal:: + + # Replace "A.B" with the METbaseimage version + ln -sf tar_files.met-base.vA.B.tgz tar_files.latest.tgz + + - Confirm the result at https://dtcenter.ucar.edu/dfiles/code/METplus/MET/installation. diff --git a/docs/Release_Guide/release_steps/met/update_version_bugfix.rst b/docs/Release_Guide/release_steps/met/update_version_bugfix.rst index 224dc35250..cc22e3cd07 100644 --- a/docs/Release_Guide/release_steps/met/update_version_bugfix.rst +++ b/docs/Release_Guide/release_steps/met/update_version_bugfix.rst @@ -1,7 +1,9 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ -* Update the version in the code and documentation: +Update the version number in the code and documentation. + +.. dropdown:: Instructions * Update the 'met_version' variable in 'src/basic/vx_util/util_constants.h' which defines the version number written to the MET output files. diff --git a/docs/Release_Guide/release_steps/met/update_version_development.rst b/docs/Release_Guide/release_steps/met/update_version_development.rst index 069d9dd926..b2052716ba 100644 --- a/docs/Release_Guide/release_steps/met/update_version_development.rst +++ b/docs/Release_Guide/release_steps/met/update_version_development.rst @@ -1,11 +1,16 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ -.. note:: +Update the version number in the code and documentation. + +.. dropdown:: Instructions + + .. note:: - 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 ` to do so prior to creating the first development release. - -* If the official release version has already been updated (e.g. beta2+ and rc1+), do the following: + 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 ` to do so prior to creating the first development release. + + + * If the official release version has already been updated (e.g. beta2+ and rc1+), 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 index d007a3878c..363b92543f 100644 --- a/docs/Release_Guide/release_steps/met/update_version_official.rst +++ b/docs/Release_Guide/release_steps/met/update_version_official.rst @@ -2,8 +2,10 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ - -* Update the version in the code and documentation: + +Update the version number in the code and documentation. + +.. dropdown:: Instructions * 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. diff --git a/docs/Release_Guide/release_steps/met/update_web_server_data.rst b/docs/Release_Guide/release_steps/met/update_web_server_data.rst index 478cfe2060..6b5fc66d19 100644 --- a/docs/Release_Guide/release_steps/met/update_web_server_data.rst +++ b/docs/Release_Guide/release_steps/met/update_web_server_data.rst @@ -1,31 +1,28 @@ Update DTC Web Server Data ^^^^^^^^^^^^^^^^^^^^^^^^^^ -Create Directory for This Release -""""""""""""""""""""""""""""""""" +For rc1 development releases, create a new testing input data directory for the upcoming official release. -.. 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. +.. dropdown:: If creating an rc1 release + On the DTC web server where the sample input data for unit tests is hosted, + create a new directory for this official major/minor release. -On the DTC web server where the sample input data for unit tests is hosted, -create a new directory for this official major/minor release. + The GitHub Actions automation creates version-specific input test data + volumes. It pulls input test data from the DTC web server, creates a Docker + data volume, and pushes the result to the dtcenter/met-data-dev DockerHub + repository. -The GitHub Actions automation creates version-specific input test data -volumes. It pulls input test data from the DTC web server, creates a Docker -data volume, and pushes the result to the dtcenter/met-data-dev DockerHub -repository. + * Log on to the DTC web server and run: -Log on to the DTC web server and run: + :: -:: + runas met_test + cd /d2/www/dtcenter/dfiles/code/METplus/MET/MET_unit_test + cp -r develop vX.Y - runas met_test - cd /d2/www/dtcenter/dfiles/code/METplus/MET/MET_unit_test - cp -r develop vX.Y + * Confirm the result at https://dtcenter.ucar.edu/dfiles/code/METplus/MET/MET_unit_test. -Confirm the result at https://dtcenter.ucar.edu/dfiles/code/METplus/MET/MET_unit_test. +.. dropdown:: If creating a betaN or rc2+ release + Continue to the next instruction. diff --git a/docs/Release_Guide/release_steps/met/update_zenodo.rst b/docs/Release_Guide/release_steps/met/update_zenodo.rst index 138aea830b..fcf74c439b 100644 --- a/docs/Release_Guide/release_steps/met/update_zenodo.rst +++ b/docs/Release_Guide/release_steps/met/update_zenodo.rst @@ -1,7 +1,11 @@ Update Zenodo ^^^^^^^^^^^^^ -In the `MET GitHub repository `_ -scroll down to the README file and check the -`MET Digital Object Identifier (DOI) `_ -on Zenodo. Use the zip file for the new MET release to create a new version on Zenodo. +Update the DOI for this official release. + +.. dropdown:: Instructions + + In the `MET GitHub repository `_ + scroll down to the README file and check the + `MET Digital Object Identifier (DOI) `_ + on Zenodo. Use the zip file for the new MET release to create a new version on Zenodo. diff --git a/docs/Release_Guide/release_steps/metcalcpy/update_version_bugfix.rst b/docs/Release_Guide/release_steps/metcalcpy/update_version_bugfix.rst index 247803c919..dd1d610bf5 100644 --- a/docs/Release_Guide/release_steps/metcalcpy/update_version_bugfix.rst +++ b/docs/Release_Guide/release_steps/metcalcpy/update_version_bugfix.rst @@ -1,7 +1,9 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ -* Update the version: +Update the software version information. + +.. dropdown:: Instructions * In 'docs/version', update '__version__'. This value is used by setup.py. diff --git a/docs/Release_Guide/release_steps/metcalcpy/update_version_development.rst b/docs/Release_Guide/release_steps/metcalcpy/update_version_development.rst index 510d07c91d..dc1b3ea4a5 100644 --- a/docs/Release_Guide/release_steps/metcalcpy/update_version_development.rst +++ b/docs/Release_Guide/release_steps/metcalcpy/update_version_development.rst @@ -1,13 +1,17 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ -.. note:: +Update the software version information. + +.. dropdown:: Instructions + + .. note:: - 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 ` to do so prior to creating the first development release. + 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 ` to do so prior to creating the first development release. -* 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 rc1+), 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. - * In 'docs/version', update '__version__'. This value is used by setup.py. + * In 'docs/version', update '__version__'. This value is used by setup.py. diff --git a/docs/Release_Guide/release_steps/metcalcpy/update_version_official.rst b/docs/Release_Guide/release_steps/metcalcpy/update_version_official.rst index e3a477a605..cf09cc0091 100644 --- a/docs/Release_Guide/release_steps/metcalcpy/update_version_official.rst +++ b/docs/Release_Guide/release_steps/metcalcpy/update_version_official.rst @@ -1,11 +1,10 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ -* Update the version: +Update the software version information. + +.. dropdown:: Instructions * If necessary, in 'docs/version', update '__version__'. This value is used by setup.py. * In 'docs/conf.py', update the 'version', 'release_year', and 'release_date' variables for the documentation. - - - diff --git a/docs/Release_Guide/release_steps/metcalcpy/update_version_on_develop.rst b/docs/Release_Guide/release_steps/metcalcpy/update_version_on_develop.rst index 99305311a2..60c4fbd179 100644 --- a/docs/Release_Guide/release_steps/metcalcpy/update_version_on_develop.rst +++ b/docs/Release_Guide/release_steps/metcalcpy/update_version_on_develop.rst @@ -1,19 +1,22 @@ Update Version on Develop Branch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Change METcalcpy/docs/version __version__ value to the next release after this one with -dev added -to the end. Releases will loosely following these names, but are subject to -change: +Update the development version information. -+-------------------+----------------------------+ -| Release Version | New Develop Version | -+===================+============================+ -| X.Y.Z-beta1 | X.Y.Z-beta2-dev | -+-------------------+----------------------------+ -| X.Y.Z-beta2 | X.Y.Z-beta3-dev | -+-------------------+----------------------------+ -| X.Y.Z-beta3 | X.Y.Z-rc1-dev | -+-------------------+----------------------------+ -| X.Y.Z-rc1 | (X+1).0.0-beta1-dev OR | -| | **X.(Y+1).0-beta1-dev** | -+-------------------+----------------------------+ +.. dropdown:: Instructions + + Change METcalcpy/docs/version __version__ value to the next release after this one with -dev added + to the end. Releases will loosely following these names, but are subject to change: + + +-------------------+----------------------------+ + | Release Version | New Develop Version | + +===================+============================+ + | X.Y.Z-beta1 | X.Y.Z-beta2-dev | + +-------------------+----------------------------+ + | X.Y.Z-beta2 | X.Y.Z-beta3-dev | + +-------------------+----------------------------+ + | X.Y.Z-beta3 | X.Y.Z-rc1-dev | + +-------------------+----------------------------+ + | X.Y.Z-rc1 | (X+1).0.0-beta1-dev OR | + | | **X.(Y+1).0-beta1-dev** | + +-------------------+----------------------------+ diff --git a/docs/Release_Guide/release_steps/metdataio/update_version_bugfix.rst b/docs/Release_Guide/release_steps/metdataio/update_version_bugfix.rst index b9c72c1a28..17050be034 100644 --- a/docs/Release_Guide/release_steps/metdataio/update_version_bugfix.rst +++ b/docs/Release_Guide/release_steps/metdataio/update_version_bugfix.rst @@ -1,7 +1,9 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ -* Update the version: +Update the software version information. + +.. dropdown:: Instructions * In 'docs/version', update the version number. This value is used by METplus use cases that run METdbLoad and is used by METviewer. diff --git a/docs/Release_Guide/release_steps/metdataio/update_version_development.rst b/docs/Release_Guide/release_steps/metdataio/update_version_development.rst index 4f99a3d8dc..8bcdba19fe 100644 --- a/docs/Release_Guide/release_steps/metdataio/update_version_development.rst +++ b/docs/Release_Guide/release_steps/metdataio/update_version_development.rst @@ -1,15 +1,19 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ -.. note:: +Update the software version information. + +.. dropdown:: Instructions + + .. note:: - 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 ` to do so prior to creating the first development release. + 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 ` to do so prior to creating the first development release. -* 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 rc1+), 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. - * In 'docs/version', update the version number. This value is used by METplus use cases that run METdbLoad and is used by METviewer. + * In 'docs/version', update the version number. This value is used by METplus use cases that run METdbLoad and is used by METviewer. - * In the top level 'pyproject.toml', update the value of 'version'. + * In the top level 'pyproject.toml', update the value of 'version'. diff --git a/docs/Release_Guide/release_steps/metdataio/update_version_official.rst b/docs/Release_Guide/release_steps/metdataio/update_version_official.rst index 2e31cfd456..e6de0cc4c9 100644 --- a/docs/Release_Guide/release_steps/metdataio/update_version_official.rst +++ b/docs/Release_Guide/release_steps/metdataio/update_version_official.rst @@ -1,11 +1,13 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ -* Update the version: +Update the software version information. - * If necessary, in 'docs/version', update the version number. This value is used by METplus use cases that run METdbLoad and is used by METviewer. +.. dropdown:: Instructions + + * If necessary, in 'docs/version', update the version number. + This value is used by METplus use cases that run METdbLoad and is used by METviewer. * If necessary, in the top level 'pyproject.toml', update the value of 'version'. * In 'docs/conf.py', update the 'version', 'release_year', and 'release_date' variables for the documentation. - diff --git a/docs/Release_Guide/release_steps/metdataio/update_version_on_develop.rst b/docs/Release_Guide/release_steps/metdataio/update_version_on_develop.rst index ad2d01901f..9d637e7b55 100644 --- a/docs/Release_Guide/release_steps/metdataio/update_version_on_develop.rst +++ b/docs/Release_Guide/release_steps/metdataio/update_version_on_develop.rst @@ -1,19 +1,22 @@ Update Version on Develop Branch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Change |projectRepo|/docs/version value to the next release after this one with -dev added -to the end. Releases will loosely follow these names, but are subject to -change: +Update the development version information. -+-------------------+----------------------------+ -| Release Version | New Develop Version | -+===================+============================+ -| X.Y.Z-beta1 | X.Y.Z-beta2-dev | -+-------------------+----------------------------+ -| X.Y.Z-beta2 | X.Y.Z-beta3-dev | -+-------------------+----------------------------+ -| X.Y.Z-beta3 | X.Y.Z-rc1-dev | -+-------------------+----------------------------+ -| X.Y.Z-rc1 | (X+1).0.0-beta1-dev OR | -| | **X.(Y+1).0-beta1-dev** | -+-------------------+----------------------------+ +.. dropdown:: Instructions + + Change |projectRepo|/docs/version value to the next release after this one with -dev added + to the end. Releases will loosely follow these names, but are subject to change: + + +-------------------+----------------------------+ + | Release Version | New Develop Version | + +===================+============================+ + | X.Y.Z-beta1 | X.Y.Z-beta2-dev | + +-------------------+----------------------------+ + | X.Y.Z-beta2 | X.Y.Z-beta3-dev | + +-------------------+----------------------------+ + | X.Y.Z-beta3 | X.Y.Z-rc1-dev | + +-------------------+----------------------------+ + | X.Y.Z-rc1 | (X+1).0.0-beta1-dev OR | + | | **X.(Y+1).0-beta1-dev** | + +-------------------+----------------------------+ diff --git a/docs/Release_Guide/release_steps/metexpress/announce_release.rst b/docs/Release_Guide/release_steps/metexpress/announce_release.rst index 5307df36ec..f2f4fbedc0 100644 --- a/docs/Release_Guide/release_steps/metexpress/announce_release.rst +++ b/docs/Release_Guide/release_steps/metexpress/announce_release.rst @@ -1,6 +1,10 @@ Announce Release ^^^^^^^^^^^^^^^^ -* Add a link for the latest production containers on https://dtcenter.org/community-code/metexpress/download. -* Select both METplus and METexpress in the multi-selector box. -* Set the current release to "recommended" and reassign the previous one to "other". +Let users know about this new release. + +.. dropdown:: Instructions + + * Add a link for the latest production containers on https://dtcenter.org/community-code/metexpress/download. + * Select both METplus and METexpress in the multi-selector box. + * Set the current release to "recommended" and reassign the previous one to "other". diff --git a/docs/Release_Guide/release_steps/metexpress/checkout_development_branch.rst b/docs/Release_Guide/release_steps/metexpress/checkout_development_branch.rst index b621bd5912..e6bfb5105f 100644 --- a/docs/Release_Guide/release_steps/metexpress/checkout_development_branch.rst +++ b/docs/Release_Guide/release_steps/metexpress/checkout_development_branch.rst @@ -1,8 +1,10 @@ Checkout the Development Branch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* Checkout the development branch: +Checkout the development branch. -.. parsed-literal:: +.. dropdown:: Instructions - git checkout development + .. parsed-literal:: + + git checkout development diff --git a/docs/Release_Guide/release_steps/metexpress/checkout_development_branch_submodules.rst b/docs/Release_Guide/release_steps/metexpress/checkout_development_branch_submodules.rst index 33549a8b2c..dd811cbd06 100644 --- a/docs/Release_Guide/release_steps/metexpress/checkout_development_branch_submodules.rst +++ b/docs/Release_Guide/release_steps/metexpress/checkout_development_branch_submodules.rst @@ -1,20 +1,21 @@ Checkout the Development Branch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* Checkout the development branch: +Checkout the development branch of the METexpress repositories. -.. parsed-literal:: +.. dropdown:: Instructions - git checkout development - git pull - cd MATScommon - git checkout development - git pull - cd ../METexpress - git checkout development - git pull - cd MATScommon - git checkout development - git pull - cd ../.. + .. parsed-literal:: + git checkout development + git pull + cd MATScommon + git checkout development + git pull + cd ../METexpress + git checkout development + git pull + cd MATScommon + git checkout development + git pull + cd ../.. diff --git a/docs/Release_Guide/release_steps/metexpress/checkout_main_branch.rst b/docs/Release_Guide/release_steps/metexpress/checkout_main_branch.rst index aab8e4a430..132a5d19a0 100644 --- a/docs/Release_Guide/release_steps/metexpress/checkout_main_branch.rst +++ b/docs/Release_Guide/release_steps/metexpress/checkout_main_branch.rst @@ -1,20 +1,21 @@ Checkout the Main Branch ^^^^^^^^^^^^^^^^^^^^^^^^ -Checkout the main branch of the METexpress repo. +Checkout the main branch of the METexpress repositories. -.. parsed-literal:: +.. dropdown:: Instructions - git checkout main - git pull - cd MATScommon - git checkout main - git pull - cd ../METexpress - git checkout main - git pull - cd MATScommon - git checkout main - git pull - cd ../.. + .. parsed-literal:: + git checkout main + git pull + cd MATScommon + git checkout main + git pull + cd ../METexpress + git checkout main + git pull + cd MATScommon + git checkout main + git pull + cd ../.. diff --git a/docs/Release_Guide/release_steps/metexpress/clone_project_repository.rst b/docs/Release_Guide/release_steps/metexpress/clone_project_repository.rst index becf56747d..fc2f4795a6 100644 --- a/docs/Release_Guide/release_steps/metexpress/clone_project_repository.rst +++ b/docs/Release_Guide/release_steps/metexpress/clone_project_repository.rst @@ -1,31 +1,34 @@ Clone the Project Repository ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* Create and work in a new directory to ensure a fresh environment: +Clone the repositories onto your local machine. -.. parsed-literal:: +.. dropdown:: Instructions - mkdir release-X.Y.Z - cd release-X.Y.Z + * Create and work in a new directory to ensure a fresh environment: -* Run the clone command to obtain the repository. -* For someone at GSL doing this, it's easiest to just do everything with METexpress as a subrepo of MATS. + .. parsed-literal:: -Using SSH: + mkdir release-X.Y.Z + cd release-X.Y.Z -.. parsed-literal:: + * Run the clone command to obtain the repository. + * For someone at GSL doing this, it's easiest to just do everything with METexpress as a subrepo of MATS. - git clone --recurse-submodules --remote-submodules git@github.com:NOAA-GSL/MATS (requires git 2.23 or later) + Using SSH: -Using HTTP: + .. parsed-literal:: -.. parsed-literal:: + git clone --recurse-submodules --remote-submodules git@github.com:NOAA-GSL/MATS (requires git 2.23 or later) - git clone --recurse-submodules --remote-submodules https://github.com/NOAA-GSL/MATS (requires git 2.23 or later) + Using HTTP: -* Enter the project repository directory: + .. parsed-literal:: -.. parsed-literal:: + git clone --recurse-submodules --remote-submodules https://github.com/NOAA-GSL/MATS (requires git 2.23 or later) - cd MATS + * Enter the project repository directory: + .. parsed-literal:: + + cd MATS diff --git a/docs/Release_Guide/release_steps/metexpress/create_development_feature_branch.rst b/docs/Release_Guide/release_steps/metexpress/create_development_feature_branch.rst index 6fac5f7b4c..30a5a2f273 100644 --- a/docs/Release_Guide/release_steps/metexpress/create_development_feature_branch.rst +++ b/docs/Release_Guide/release_steps/metexpress/create_development_feature_branch.rst @@ -1,10 +1,14 @@ Create Development Feature Branch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* Create a feature branch in which to perform any required development work. +Create a feature branch. -.. parsed-literal:: +.. dropdown:: Instructions - git checkout -b feature_brief_description_of_work + * Create a feature branch in which to perform any required development work. -* Make desired code changes. + .. parsed-literal:: + + git checkout -b feature_brief_description_of_work + + * Make desired code changes. diff --git a/docs/Release_Guide/release_steps/metexpress/deploy_AWS_apps.rst b/docs/Release_Guide/release_steps/metexpress/deploy_AWS_apps.rst deleted file mode 100644 index 17010885b5..0000000000 --- a/docs/Release_Guide/release_steps/metexpress/deploy_AWS_apps.rst +++ /dev/null @@ -1,26 +0,0 @@ -Deploy AWS apps -^^^^^^^^^^^^^^^ - -* On metexpress.nws.noaa.gov (VPN and permissions required), go to the container_deployment directory. - -.. parsed-literal:: - - ssh metexpress.nws.noaa.gov - sudo -i -u metexpress - cd container_deployment - -* Add any new apps to docker_compose.yml and web/applist.json. Update the container version numbers in docker_compose.yml, and any settings files in settings/ - -.. parsed-literal:: - - vi docker_compose.yml - vi web/applist.json - vi settings/appname/settings.json - -* Redeploy the apps. - -.. parsed-literal:: - - bin/redeploy metexpress - -* Sometimes the apps take a while to start up on AWS. Be patient. diff --git a/docs/Release_Guide/release_steps/metexpress/deploy_beta_apps.rst b/docs/Release_Guide/release_steps/metexpress/deploy_beta_apps.rst index cacd1260b8..8e236aed7b 100644 --- a/docs/Release_Guide/release_steps/metexpress/deploy_beta_apps.rst +++ b/docs/Release_Guide/release_steps/metexpress/deploy_beta_apps.rst @@ -1,27 +1,31 @@ Deploy Beta Apps ^^^^^^^^^^^^^^^^ -* After the apps build, which usually takes about 20 minutes, they should be installed on the dedicated beta server (mats-docker-int) for third party testing. +Install the built apps. -* On mats-docker-int.gsd.esrl.noaa.gov (the beta server, VPN and permissions required), go to the container_deployment directory. +.. dropdown:: Instructions -.. parsed-literal:: + * After the apps build, which usually takes about 20 minutes, they should be installed on the dedicated beta server (mats-docker-int) for third party testing. - ssh www-data@mats-docker-int.gsd.esrl.noaa.gov - cd container_deployment + * On mats-docker-int.gsd.esrl.noaa.gov (the beta server, VPN and permissions required), go to the container_deployment directory. -* Add any new apps to docker_compose.yml and web/applist.json. Update the container version numbers in docker_compose.yml, and any settings files in settings/ + .. parsed-literal:: -.. parsed-literal:: + ssh www-data@mats-docker-int.gsd.esrl.noaa.gov + cd container_deployment - vi docker_compose.yml - vi web/applist.json - vi settings/appname/settings.json + * Add any new apps to docker_compose.yml and web/applist.json. Update the container version numbers in docker_compose.yml, and any settings files in settings/ -* Redeploy the apps. + .. parsed-literal:: -.. parsed-literal:: + vi docker_compose.yml + vi web/applist.json + vi settings/appname/settings.json - bin/redeploy production + * Redeploy the apps. -* Contact your dedicated beta tester to ensure the apps work as expected. + .. parsed-literal:: + + bin/redeploy production + + * Contact your dedicated beta tester to ensure the apps work as expected. diff --git a/docs/Release_Guide/release_steps/metexpress/deploy_production_apps.rst b/docs/Release_Guide/release_steps/metexpress/deploy_production_apps.rst index d6f71f1097..e4278d37f6 100644 --- a/docs/Release_Guide/release_steps/metexpress/deploy_production_apps.rst +++ b/docs/Release_Guide/release_steps/metexpress/deploy_production_apps.rst @@ -1,25 +1,29 @@ Deploy Production Apps ^^^^^^^^^^^^^^^^^^^^^^ -* If the beta tester approves the apps, deploy them to the production server (mats-docker). +Deploy the METexpress apps to the production server. -* On mats-docker.gsd.esrl.noaa.gov (the production server, VPN and permissions required), go to the container_deployment directory. +.. dropdown:: Instructions -.. parsed-literal:: + * If the beta tester approves the apps, deploy them to the production server (mats-docker). - ssh www-data@mats-docker.gsd.esrl.noaa.gov - cd container_deployment + * On mats-docker.gsd.esrl.noaa.gov (the production server, VPN and permissions required), go to the container_deployment directory. -* Add any new apps to docker_compose.yml and web/applist.json. Update the container version numbers in docker_compose.yml, and any settings files in settings/ + .. parsed-literal:: -.. parsed-literal:: + ssh www-data@mats-docker.gsd.esrl.noaa.gov + cd container_deployment - vi docker_compose.yml - vi web/applist.json - vi settings/appname/settings.json + * Add any new apps to docker_compose.yml and web/applist.json. Update the container version numbers in docker_compose.yml, and any settings files in settings/ -* Redeploy the apps. + .. parsed-literal:: -.. parsed-literal:: + vi docker_compose.yml + vi web/applist.json + vi settings/appname/settings.json - bin/redeploy production + * Redeploy the apps. + + .. parsed-literal:: + + bin/redeploy production diff --git a/docs/Release_Guide/release_steps/metexpress/merge_development_to_main.rst b/docs/Release_Guide/release_steps/metexpress/merge_development_to_main.rst index f94228f831..2c79700307 100644 --- a/docs/Release_Guide/release_steps/metexpress/merge_development_to_main.rst +++ b/docs/Release_Guide/release_steps/metexpress/merge_development_to_main.rst @@ -1,21 +1,26 @@ Merge Development Changes to Main Branch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* ONLY PROCEED TO THIS STEP IF ALL OF THE AUTOMATED TESTS PASS FOR THE LATEST NIGHTLY DEVELOPMENT BUILD AT mats-docker-dev.gsd.esrl.noaa.gov (VPN required). +Merge changes into the main branch. -* Merge the latest development code into the main branch and push to origin. +.. note:: -.. parsed-literal:: + ONLY PROCEED TO THIS STEP IF ALL OF THE AUTOMATED TESTS PASS FOR THE LATEST NIGHTLY DEVELOPMENT BUILD AT mats-docker-dev.gsd.esrl.noaa.gov (VPN required). - git merge development - git push - cd MATScommon - git merge development - git push - cd ../METexpress - git merge development - git push - cd MATScommon - git pull - cd ../.. +.. dropdown:: Instructions + * Merge the latest development code into the main branch and push to origin. + + .. parsed-literal:: + + git merge development + git push + cd MATScommon + git merge development + git push + cd ../METexpress + git merge development + git push + cd MATScommon + git pull + cd ../.. diff --git a/docs/Release_Guide/release_steps/metexpress/merge_feature_branch.rst b/docs/Release_Guide/release_steps/metexpress/merge_feature_branch.rst index 7f1b765d1c..13196cbf14 100644 --- a/docs/Release_Guide/release_steps/metexpress/merge_feature_branch.rst +++ b/docs/Release_Guide/release_steps/metexpress/merge_feature_branch.rst @@ -1,4 +1,4 @@ Merge Feature Branch ^^^^^^^^^^^^^^^^^^^^ -* After making the desired code changes on a feature branch, submit a pull request to merge those changes back into the development branch. +After making the desired code changes on a feature branch, submit a pull request to merge those changes back into the development branch. diff --git a/docs/Release_Guide/release_steps/metexpress/pull_changes_and_merge_to_dev.rst b/docs/Release_Guide/release_steps/metexpress/pull_changes_and_merge_to_dev.rst index e8e2b875c6..a24ba540c4 100644 --- a/docs/Release_Guide/release_steps/metexpress/pull_changes_and_merge_to_dev.rst +++ b/docs/Release_Guide/release_steps/metexpress/pull_changes_and_merge_to_dev.rst @@ -1,71 +1,74 @@ Pull Changes, Create Release Branch, And Merge To Development ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* On your system, pull any build-related code changes. +Pull changes, create release branch, and merge to development. -.. parsed-literal:: +.. dropdown:: Instructions - git pull - cd MATScommon - git pull - cd ../METexpress - git pull - cd MATScommon - git pull - cd ../.. + * On your system, pull any build-related code changes. -* Create a release branch of the format main_vX.Y.Z. using your release version. + .. parsed-literal:: -.. parsed-literal:: + git pull + cd MATScommon + git pull + cd ../METexpress + git pull + cd MATScommon + git pull + cd ../.. - git checkout -b main_vX.Y.Z - git push -u origin main_vX.Y.Z - cd MATScommon - git checkout -b main_vX.Y.Z - git push -u origin main_vX.Y.Z - cd ../METexpress - git checkout -b main_vX.Y.Z - git push -u origin main_vX.Y.Z - cd MATScommon - git checkout -b main_vX.Y.Z - git push -u origin main_vX.Y.Z - cd ../.. + * Create a release branch of the format main_vX.Y.Z. using your release version. -* Checkout development and merge any build-related changes. + .. parsed-literal:: -.. parsed-literal:: + git checkout -b main_vX.Y.Z + git push -u origin main_vX.Y.Z + cd MATScommon + git checkout -b main_vX.Y.Z + git push -u origin main_vX.Y.Z + cd ../METexpress + git checkout -b main_vX.Y.Z + git push -u origin main_vX.Y.Z + cd MATScommon + git checkout -b main_vX.Y.Z + git push -u origin main_vX.Y.Z + cd ../.. - git checkout development - git merge main - git push - cd MATScommon - git checkout development - git merge main - git push - cd ../METexpress - git checkout development - git merge main - git push - cd MATScommon - git pull - cd ../.. + * Checkout development and merge any build-related changes. -* Add the following code to the top of MATS/MATScommon/meteor_packages/mats-common/public/MATSReleaseNotes.html. + .. parsed-literal:: -.. parsed-literal:: + git checkout development + git merge main + git push + cd MATScommon + git checkout development + git merge main + git push + cd ../METexpress + git checkout development + git merge main + git push + cd MATScommon + git pull + cd ../.. -
-
-
-
-

Production build date: Current revision

-

Integration build date: Not yet built

-

-

PUT APP VERSIONS HERE

-

-

Changes:

-

* PUT CHANGES HERE

-
+ * Add the following code to the top of MATS/MATScommon/meteor_packages/mats-common/public/MATSReleaseNotes.html. -* Commit and push to origin/development. + .. parsed-literal:: +
+
+
+
+

Production build date: Current revision

+

Integration build date: Not yet built

+

+

PUT APP VERSIONS HERE

+

+

Changes:

+

* PUT CHANGES HERE

+
+ + * Commit and push to origin/development. diff --git a/docs/Release_Guide/release_steps/metexpress/tag_app_version_and_build.rst b/docs/Release_Guide/release_steps/metexpress/tag_app_version_and_build.rst index 5fa31c1ca3..809c5cbd2b 100644 --- a/docs/Release_Guide/release_steps/metexpress/tag_app_version_and_build.rst +++ b/docs/Release_Guide/release_steps/metexpress/tag_app_version_and_build.rst @@ -1,20 +1,24 @@ Tag App Version and Build ^^^^^^^^^^^^^^^^^^^^^^^^^ -* METexpress apps are versioned as major.minor.patch. To trigger the build of a specific version, you will need to tag the current main branch in all the repositories with the version number. +Tag the mains branches. -.. parsed-literal:: +.. dropdown:: Instructions - git tag vX.Y.Z - git push origin vX.Y.Z - cd MATScommon - git tag vX.Y.Z - git push origin vX.Y.Z - cd ../METexpress - git tag vX.Y.Z - git push origin vX.Y.Z - cd MATScommon - git pull - cd ../.. + * METexpress apps are versioned as major.minor.patch. To trigger the build of a specific version, you will need to tag the current main branch in all the repositories with the version number. -* This will cause github to automatically build the versioned app containers for the release. + .. parsed-literal:: + + git tag vX.Y.Z + git push origin vX.Y.Z + cd MATScommon + git tag vX.Y.Z + git push origin vX.Y.Z + cd ../METexpress + git tag vX.Y.Z + git push origin vX.Y.Z + cd MATScommon + git pull + cd ../.. + + * This will cause github to automatically build the versioned app containers for the release. diff --git a/docs/Release_Guide/release_steps/metexpress/update_dates_and_versions.rst b/docs/Release_Guide/release_steps/metexpress/update_dates_and_versions.rst index 210b41f4bd..4ffbfd72af 100644 --- a/docs/Release_Guide/release_steps/metexpress/update_dates_and_versions.rst +++ b/docs/Release_Guide/release_steps/metexpress/update_dates_and_versions.rst @@ -1,19 +1,23 @@ Update Release Notes ^^^^^^^^^^^^^^^^^^^^ -You can refer to the GitHub Issues page to see what has changed for this -release. Open the following URLs in a browser: +Update the release notes for this release. -.. parsed-literal:: +.. dropdown:: Instructions - https://github.com/NOAA-GSL/MATS/issues - https://github.com/dtcenter/|projectRepo|/issues + You can refer to the GitHub Issues page to see what has changed for this + release. Open the following URLs in a browser: -* Compile a list of all changes since the last time the development branch was merged into the main branch. + .. parsed-literal:: -* Update the top entry in MATS/MATScommon/meteor_packages/mats-common/public/MATSReleaseNotes.html to reflect - these changes, as well as the new version number. Set the Production Build Date to the current date. + https://github.com/NOAA-GSL/MATS/issues + https://github.com/dtcenter/|projectRepo|/issues -* Update the version and release date in docs/conf.py. + * Compile a list of all changes since the last time the development branch was merged into the main branch. + + * Update the top entry in MATS/MATScommon/meteor_packages/mats-common/public/MATSReleaseNotes.html to reflect + these changes, as well as the new version number. Set the Production Build Date to the current date. + + * Update the version and release date in docs/conf.py. -* Commit changes and push to GitHub origin/development. + * Commit changes and push to GitHub origin/development. diff --git a/docs/Release_Guide/release_steps/metplotpy/update_version_bugfix.rst b/docs/Release_Guide/release_steps/metplotpy/update_version_bugfix.rst index 883f3a93f5..870273bfd3 100644 --- a/docs/Release_Guide/release_steps/metplotpy/update_version_bugfix.rst +++ b/docs/Release_Guide/release_steps/metplotpy/update_version_bugfix.rst @@ -1,7 +1,8 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ -* Update the version: +Update the software version information. - * In 'docs/conf.py', update the 'version', 'release_year', and 'release_date' variables for the documentation. +.. dropdown:: Instructions + * In 'docs/conf.py', update the 'version', 'release_year', and 'release_date' variables for the documentation. diff --git a/docs/Release_Guide/release_steps/metplotpy/update_version_development.rst b/docs/Release_Guide/release_steps/metplotpy/update_version_development.rst index 069d9dd926..f484932040 100644 --- a/docs/Release_Guide/release_steps/metplotpy/update_version_development.rst +++ b/docs/Release_Guide/release_steps/metplotpy/update_version_development.rst @@ -1,11 +1,15 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ -.. note:: +Update the software version information. + +.. dropdown:: Instructions + + .. note:: - 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 ` to do so prior to creating the first development release. + 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 ` to do so prior to creating the first development release. -* 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 rc1+), 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/metplotpy/update_version_official.rst b/docs/Release_Guide/release_steps/metplotpy/update_version_official.rst index 883f3a93f5..870273bfd3 100644 --- a/docs/Release_Guide/release_steps/metplotpy/update_version_official.rst +++ b/docs/Release_Guide/release_steps/metplotpy/update_version_official.rst @@ -1,7 +1,8 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ -* Update the version: +Update the software version information. - * In 'docs/conf.py', update the 'version', 'release_year', and 'release_date' variables for the documentation. +.. dropdown:: Instructions + * In 'docs/conf.py', update the 'version', 'release_year', and 'release_date' variables for the documentation. diff --git a/docs/Release_Guide/release_steps/metplotpy/update_version_on_develop.rst b/docs/Release_Guide/release_steps/metplotpy/update_version_on_develop.rst index 52ff99ea4f..41eda83a45 100644 --- a/docs/Release_Guide/release_steps/metplotpy/update_version_on_develop.rst +++ b/docs/Release_Guide/release_steps/metplotpy/update_version_on_develop.rst @@ -1,19 +1,22 @@ Update Version on Develop Branch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Change METplotpy/docs/version __version__ value to the next release after this one with -dev added -to the end. Releases will loosely following these names, but are subject to -change: +Update the development version information. -+-------------------+----------------------------+ -| Release Version | New Develop Version | -+===================+============================+ -| X.Y.Z-beta1 | X.Y.Z-beta2-dev | -+-------------------+----------------------------+ -| X.Y.Z-beta2 | X.Y.Z-beta3-dev | -+-------------------+----------------------------+ -| X.Y.Z-beta3 | X.Y.Z-rc1-dev | -+-------------------+----------------------------+ -| X.Y.Z-rc1 | (X+1).0.0-beta1-dev OR | -| | **X.(Y+1).0-beta1-dev** | -+-------------------+----------------------------+ +.. dropdown:: Instructions + + Change METplotpy/docs/version __version__ value to the next release after this one with -dev added + to the end. Releases will loosely following these names, but are subject to change: + + +-------------------+----------------------------+ + | Release Version | New Develop Version | + +===================+============================+ + | X.Y.Z-beta1 | X.Y.Z-beta2-dev | + +-------------------+----------------------------+ + | X.Y.Z-beta2 | X.Y.Z-beta3-dev | + +-------------------+----------------------------+ + | X.Y.Z-beta3 | X.Y.Z-rc1-dev | + +-------------------+----------------------------+ + | X.Y.Z-rc1 | (X+1).0.0-beta1-dev OR | + | | **X.(Y+1).0-beta1-dev** | + +-------------------+----------------------------+ 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 index 006d56c45d..f91e02fa87 100644 --- 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 @@ -1,38 +1,42 @@ 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. +Add version information for the next coordinated release. -If the X.0 release was just created, add an entry for the X.1 release. +.. dropdown:: Instructions -If the X.1 release was just created, add an entry for the X+1.0 release. + In the develop branch, modify the **metplus/component_versions.py** file to + add an entry for the next coordinated release. -Set the appropriate X.Y.0 versions for each component. -Maybe sure to set the Z number to 0. + If the X.0 release was just created, add an entry for the X.1 release. -Set the version for metexpress to None (not a string). + If the X.1 release was just created, add an entry for the X+1.0 release. -For example, if the coordinated 6.0 release was just created, add:: + Set the appropriate X.Y.0 versions for each component. + Maybe sure to set the Z number to 0. - '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, - }, + Set the version for metexpress to None (not a string). -For example, if the coordinated 6.1 release was just created, add:: + For example, if the coordinated 6.0 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, - }, + '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/metplus/coordinated_release_announcement.rst b/docs/Release_Guide/release_steps/metplus/coordinated_release_announcement.rst index 2c7eb97a3d..a0e50ce517 100644 --- a/docs/Release_Guide/release_steps/metplus/coordinated_release_announcement.rst +++ b/docs/Release_Guide/release_steps/metplus/coordinated_release_announcement.rst @@ -1,7 +1,11 @@ Coordinated Release Announcement ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Send an email to the 'metplus-all' Google group indicating the completion of -the coordinated METplus release. This email serves as notification to the -project manager that an announcement can now be sent to the METplus -community. +Let the team know about this new coordinated release. + +.. dropdown:: Instructions + + Send an email to the 'metplus-all' Google group indicating the completion of + the coordinated METplus release. This email serves as notification to the + project manager that an announcement can now be sent to the METplus + community. diff --git a/docs/Release_Guide/release_steps/metplus/create_release_extra.rst b/docs/Release_Guide/release_steps/metplus/create_release_extra.rst deleted file mode 100644 index 1a30f2322c..0000000000 --- a/docs/Release_Guide/release_steps/metplus/create_release_extra.rst +++ /dev/null @@ -1,9 +0,0 @@ -* Add link to `METplus_Data `_ - and add a note to instruct users to use sub-directory corresponding to this - release, i.e. v4.0) - Refer to a previous release to easily copy and modify this information. - -* If this is a development release, check the box that says "This is a pre-release" - and uncheck "Set as latest release". - -* Click on "Publish release". diff --git a/docs/Release_Guide/release_steps/metplus/create_release_on_github.rst b/docs/Release_Guide/release_steps/metplus/create_release_on_github.rst new file mode 100644 index 0000000000..4cb57cd30f --- /dev/null +++ b/docs/Release_Guide/release_steps/metplus/create_release_on_github.rst @@ -0,0 +1,42 @@ +Create Release on GitHub +^^^^^^^^^^^^^^^^^^^^^^^^ + +Create the new release on GitHub. + +.. dropdown:: Instructions + + * Ensure that any and all dependent releases for |projectRepo| + have been created according to :ref:`releaseDependencies`. + + * Go to Releases on GitHub and click 'Draft a new release' + + * 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) + + * Define the 'Target' branch as: + + * '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 + (Note: the URL will not be active until the release is created) + Refer to a previous release to easily copy and modify this information. + + * 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) + Refer to a previous release to easily copy and modify this information. + + * Add link to `METplus_Data `_ + and add a note to instruct users to use sub-directory corresponding to this + release, i.e. v4.0) + Refer to a previous release to easily copy and modify this information. + + * If this is a development release, check the box that says "This is a pre-release". + + * Click on "Publish release". diff --git a/docs/Release_Guide/release_steps/metplus/create_release_reference_branch.rst b/docs/Release_Guide/release_steps/metplus/create_release_reference_branch.rst index b4bf001c28..9aa934e507 100644 --- a/docs/Release_Guide/release_steps/metplus/create_release_reference_branch.rst +++ b/docs/Release_Guide/release_steps/metplus/create_release_reference_branch.rst @@ -1,86 +1,83 @@ Create Release Reference Branch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. note:: +For rc1 development releases, create a new reference branch for the upcoming official release. - 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. +.. dropdown:: If creating an rc1 release + * For METplus, the corresponding MET release must be created before starting + this step. Specifically, a DockerHub tag on dtcenter/met that is named + (X+6).Y-latest must already exist. For example, for METplus 4.1.0, the MET + DockerHub tag for 10.1-latest must be built. + See https://hub.docker.com/repository/docker/dtcenter/met/general for + a list of existing tags. -* For METplus, the corresponding MET release must be created before starting - this step. Specifically, a DockerHub tag on dtcenter/met that is named - (X+6).Y-latest must already exist. For example, for METplus 4.1.0, the MET - DockerHub tag for 10.1-latest must be built. - See https://hub.docker.com/repository/docker/dtcenter/met/general for - a list of existing tags. + * 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. -* 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:: -.. parsed-literal:: + cd |projectRepo| + git checkout develop + git pull + git checkout -b main_vX.Y-ref - cd |projectRepo| - git checkout develop - git pull - git checkout -b main_vX.Y-ref + * Update the version number -Update the version number -""""""""""""""""""""""""" + Update the content that should go into the release version but remain unchanged + in the develop branch. -Update the content that should go into the release version but remain unchanged -in the develop branch. + Note that this step is mandatory because pushing a new main_vX.Y-ref branch + without any new commits will **not** trigger the GitHub Actions workflow to + create the output Docker data volumes. -Note that this step is mandatory because pushing a new main_vX.Y-ref branch -without any new commits will **not** trigger the GitHub Actions workflow to -create the output Docker data volumes. + * Remove **-dev** from the -rc1 version number: -Remove **-dev** from the -rc1 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**. + * The version should match the upcoming release with the -rc1 suffix, + like X.Y.Z-rc1 + * Remove **-dev** from the version number so that it matches the release + you are creating. -* 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**. -* The version should match the upcoming release with the -rc1 suffix, - like X.Y.Z-rc1 -* Remove **-dev** from the version number so that it matches the release - you are creating. + * Commit these changes. -Commit these changes. + * Push Reference Branch to GitHub -Push Reference Branch to GitHub -""""""""""""""""""""""""""""""" + :: -:: + git push -u origin main_vX.Y-ref - 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. -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 -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. -Navigate to https://github.com/dtcenter/METplus/actions and verify that a -*Testing* workflow was triggered on the *main_vX.Y-ref* branch. + .. figure:: /Release_Guide/release_steps/metplus/metplus-automation-reference-data.png -.. figure:: /Release_Guide/release_steps/metplus/metplus-automation-reference-data.png + * 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/metplus-data-dev). The names + of these volumes start with *output-*. -* 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/metplus-data-dev). The names - of these volumes start with *output-*. + * Create main branch and push to GitHub -Create main branch and push to GitHub -""""""""""""""""""""""""""""""""""""" + * After the truth data volumes have been generated, create the 'main_vX.Y' + branch from 'main_vX.Y-ref' branch. All remaining development for the upcoming + official release occurs on this new 'main_vX.Y' branch. -* After the truth data volumes have been generated, create the 'main_vX.Y' - branch from 'main_vX.Y-ref' branch. All remaining development for the upcoming - official release occurs on this new 'main_vX.Y' branch. + :: -:: + git checkout -b main_vX.Y + git push -u origin main_vX.Y - git checkout -b main_vX.Y - git push -u origin main_vX.Y +.. dropdown:: If creating a betaN or rc2+ release + + Continue to the next instruction. diff --git a/docs/Release_Guide/release_steps/metplus/update_development_timeline.rst b/docs/Release_Guide/release_steps/metplus/update_development_timeline.rst index 8b1f8f4c78..8e93a201a7 100644 --- a/docs/Release_Guide/release_steps/metplus/update_development_timeline.rst +++ b/docs/Release_Guide/release_steps/metplus/update_development_timeline.rst @@ -1,18 +1,22 @@ Update Development Timeline ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* For the METplus repository, update the **development timeline** under the - `METplus Release Information `_ - section. +Update the details in the development timeline. - * If you are creating an **official** release, edit the actual - release date for the release and remove development timeline - information for all beta/rc versions. +.. dropdown:: Instructions - * If you are creating a **beta1** release, add development timeline - information with approximate dates for planned development cycles. + * For the METplus repository, update the **development timeline** under the + `METplus Release Information `_ + section. - * For other development release, edit the actual release dates and planned - release dates for future development cycles, as needed. + * If you are creating an **official** release, edit the actual + release date for the release and remove development timeline + information for all beta/rc versions. -* Commit changes and push to GitHub. + * If you are creating a **beta1** release, add development timeline + information with approximate dates for planned development cycles. + + * For other development release, edit the actual release dates and planned + release dates for future development cycles, as needed. + + * Commit changes and push to GitHub. diff --git a/docs/Release_Guide/release_steps/metplus/update_existing_builds_docker.rst b/docs/Release_Guide/release_steps/metplus/update_existing_builds_docker.rst index b5f209dba8..d3d0b77f91 100644 --- a/docs/Release_Guide/release_steps/metplus/update_existing_builds_docker.rst +++ b/docs/Release_Guide/release_steps/metplus/update_existing_builds_docker.rst @@ -1,17 +1,21 @@ Update DockerHub Info in Existing Builds ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* In **docs/Users_Guide/existing_builds.rst**, update the information under the - DockerHub dropdown menu. +Update existing build information on DockerHub. - * Review the version numbers for the - MET, METplus, and METplus Analysis - DockerHub items and update them as needed. +.. dropdown:: Instructions - * Update the "Last Updated:" information to include the release date, - e.g. November 14, 2024. + * In **docs/Users_Guide/existing_builds.rst**, update the information under the + DockerHub dropdown menu. - * If you are creating a **beta1** release, remove the text that says - "- Coming Soon!" in the dropdown menu label. + * Review the version numbers for the + MET, METplus, and METplus Analysis + DockerHub items and update them as needed. -* Commit changes and push to GitHub. + * Update the "Last Updated:" information to include the release date, + e.g. November 14, 2024. + + * If you are creating a **beta1** release, remove the text that says + "- Coming Soon!" in the dropdown menu label. + + * Commit changes and push to GitHub. diff --git a/docs/Release_Guide/release_steps/metplus/update_release_date.rst b/docs/Release_Guide/release_steps/metplus/update_release_date.rst index b04c5b677b..78b90b2e22 100644 --- a/docs/Release_Guide/release_steps/metplus/update_release_date.rst +++ b/docs/Release_Guide/release_steps/metplus/update_release_date.rst @@ -1,5 +1,9 @@ Update Release Date ^^^^^^^^^^^^^^^^^^^ -* The release date is stored in *metplus/RELEASE_DATE* in YYYYMMDD format. -* Change the value stored in this file to match the current date. +Update the date for the official release. + +.. dropdown:: Instructions + + * The release date is stored in *metplus/RELEASE_DATE* in YYYYMMDD format. + * Change the value stored in this file to match the current date. diff --git a/docs/Release_Guide/release_steps/metplus/update_version_bugfix.rst b/docs/Release_Guide/release_steps/metplus/update_version_bugfix.rst index 105ae74d8b..9ac7831a36 100644 --- a/docs/Release_Guide/release_steps/metplus/update_version_bugfix.rst +++ b/docs/Release_Guide/release_steps/metplus/update_version_bugfix.rst @@ -1,8 +1,9 @@ Update Version Number for Release ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Update the version number for the bugfix release: +Update the version number for this bugfix release. -* The *VERSION* file is located in the **metplus** subdirectory. -* If the current release is listed as X.Y.Z, the bugfix version should be X.Y.Z+1, i.e. if on 3.1.0 change to 3.1.1 +.. dropdown:: Instructions + * The *VERSION* file is located in the **metplus** subdirectory. + * If the current release is listed as X.Y.Z, the bugfix version should be X.Y.Z+1, i.e. if on 3.1.0 change to 3.1.1 diff --git a/docs/Release_Guide/release_steps/metplus/update_version_official.rst b/docs/Release_Guide/release_steps/metplus/update_version_official.rst index 360f05a6e1..45921421a2 100644 --- a/docs/Release_Guide/release_steps/metplus/update_version_official.rst +++ b/docs/Release_Guide/release_steps/metplus/update_version_official.rst @@ -1,7 +1,9 @@ Update Version Number for Official Release ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Update the version number for the official release: +Update the version number for this official release. -* The *VERSION* file is located in the **metplus** subdirectory. -* Remove the -rcN suffix so the version matches the format X.Y.0 +.. dropdown:: Instructions + + * The *VERSION* file is located in the **metplus** subdirectory. + * Remove the -rcN suffix so the version matches the format X.Y.0 diff --git a/docs/Release_Guide/release_steps/metplus/update_version_on_develop.rst b/docs/Release_Guide/release_steps/metplus/update_version_on_develop.rst index a5abe5c009..425cc3bb16 100644 --- a/docs/Release_Guide/release_steps/metplus/update_version_on_develop.rst +++ b/docs/Release_Guide/release_steps/metplus/update_version_on_develop.rst @@ -1,19 +1,23 @@ Update Version on Develop Branch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Switch to the develop branch and change metplus/VERSION value to the -next release after this one with -dev added to the end. -Releases will loosely following these names, but are subject to change: +Update the development version information. -+-------------------+----------------------------+ -| Release Version | New Develop Version | -+===================+============================+ -| X.Y.Z-beta1 | X.Y.Z-beta2-dev | -+-------------------+----------------------------+ -| X.Y.Z-beta2 | X.Y.Z-beta3-dev | -+-------------------+----------------------------+ -| X.Y.Z-beta3 | X.Y.Z-rc1-dev | -+-------------------+----------------------------+ -| X.Y.Z-rc1 | (X+1).0.0-beta1-dev OR | -| | **X.(Y+1).0-beta1-dev** | -+-------------------+----------------------------+ +.. dropdown:: Instructions + + Switch to the develop branch and change metplus/VERSION value to the + next release after this one with -dev added to the end. + Releases will loosely following these names, but are subject to change: + + +-------------------+----------------------------+ + | Release Version | New Develop Version | + +===================+============================+ + | X.Y.Z-beta1 | X.Y.Z-beta2-dev | + +-------------------+----------------------------+ + | X.Y.Z-beta2 | X.Y.Z-beta3-dev | + +-------------------+----------------------------+ + | X.Y.Z-beta3 | X.Y.Z-rc1-dev | + +-------------------+----------------------------+ + | X.Y.Z-rc1 | (X+1).0.0-beta1-dev OR | + | | **X.(Y+1).0-beta1-dev** | + +-------------------+----------------------------+ diff --git a/docs/Release_Guide/release_steps/metplus/update_web_server_data.rst b/docs/Release_Guide/release_steps/metplus/update_web_server_data.rst index aaf4d59bac..b13b6ec5a9 100644 --- a/docs/Release_Guide/release_steps/metplus/update_web_server_data.rst +++ b/docs/Release_Guide/release_steps/metplus/update_web_server_data.rst @@ -1,10 +1,9 @@ Update DTC Web Server Data ^^^^^^^^^^^^^^^^^^^^^^^^^^ -Create Directory for Next Release -""""""""""""""""""""""""""""""""" +Create a directory for the next release. -.. dropdown:: If creating a rc1 release +.. dropdown:: If creating an rc1 release On the DTC web server where the sample input data for use cases is hosted, run the setup_next_release_data.py script for the next upcoming release diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst b/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst index f7f5d93d97..7b24a622c1 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst @@ -1,7 +1,9 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ -* Update the version: +Update the software version information. + +.. dropdown:: Instructions * In the top level file 'build.xml', update the version value for the attribute name 'Specification-Version' under the 'dist' target name. diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_development.rst b/docs/Release_Guide/release_steps/metviewer/update_version_development.rst index c3c51d1421..29a6175eac 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version_development.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version_development.rst @@ -1,19 +1,23 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ -.. note:: +Update the software version information. + +.. dropdown:: Instructions + + .. note:: - 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 ` to do so prior to creating the first development release. + 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 ` to do so prior to creating the first development release. -* 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 rc1+), 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. - * In the top level file 'build.xml', update the version value for the attribute name 'Specification-Version' under the 'dist' target name. + * In the top level file 'build.xml', update the version value for the attribute name 'Specification-Version' under the 'dist' target name. - * In the 'webapp/metviewer/metviewer1.jsp' file: + * In the 'webapp/metviewer/metviewer1.jsp' file: - * Update the 'TITLE' version value under 'HEAD'. + * Update the 'TITLE' version value under 'HEAD'. - * Update the version value in the :code:`span id="release"` section. + * Update the version value in the :code:`span id="release"` section. diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_official.rst b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst index 778469e6ea..2e5404fba9 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version_official.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst @@ -1,7 +1,9 @@ Update Version Number ^^^^^^^^^^^^^^^^^^^^^ -* Update the version: +Update the software version information. + +.. dropdown:: Instructions * If necessary, in the top level file 'build.xml', update the version value for the attribute name 'Specification-Version' under the 'dist' target name. @@ -12,4 +14,3 @@ Update Version Number * Update the version value in the :code:`span id="release"` section. * In 'docs/conf.py', update the 'version', 'release_year', and 'release_date' variables for the documentation. - diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst b/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst index 10a869a166..2de3278ee9 100644 --- a/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst +++ b/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst @@ -1,19 +1,22 @@ Update Version on Develop Branch ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Change METviewer/docs/version __version__ value to the next release after this one with -dev added -to the end. Releases will loosely following these names, but are subject to -change: +Update the development version information. -+-------------------+----------------------------+ -| Release Version | New Develop Version | -+===================+============================+ -| X.Y.Z-beta1 | X.Y.Z-beta2-dev | -+-------------------+----------------------------+ -| X.Y.Z-beta2 | X.Y.Z-beta3-dev | -+-------------------+----------------------------+ -| X.Y.Z-beta3 | X.Y.Z-rc1-dev | -+-------------------+----------------------------+ -| X.Y.Z-rc1 | (X+1).0.0-beta1-dev OR | -| | **X.(Y+1).0-beta1-dev** | -+-------------------+----------------------------+ +.. dropdown:: Instructions + + Change METviewer/docs/version __version__ value to the next release after this one with -dev added + to the end. Releases will loosely following these names, but are subject to change: + + +-------------------+----------------------------+ + | Release Version | New Develop Version | + +===================+============================+ + | X.Y.Z-beta1 | X.Y.Z-beta2-dev | + +-------------------+----------------------------+ + | X.Y.Z-beta2 | X.Y.Z-beta3-dev | + +-------------------+----------------------------+ + | X.Y.Z-beta3 | X.Y.Z-rc1-dev | + +-------------------+----------------------------+ + | X.Y.Z-rc1 | (X+1).0.0-beta1-dev OR | + | | **X.(Y+1).0-beta1-dev** | + +-------------------+----------------------------+ diff --git a/docs/Release_Guide/release_steps/open_release_issue.rst b/docs/Release_Guide/release_steps/open_release_issue.rst index 35042da089..e86ee401d1 100644 --- a/docs/Release_Guide/release_steps/open_release_issue.rst +++ b/docs/Release_Guide/release_steps/open_release_issue.rst @@ -1,14 +1,18 @@ Open Release Issue ^^^^^^^^^^^^^^^^^^ -* Define a new issue in the |projectRepo| repository to create the new release. +Define a new GitHub issue for creating this new release. - * "Create the |projectRepo| vX.Y.Z release" for an official or bugfix release. +.. dropdown:: Instructions - * "Create the |projectRepo| vX.Y.Z-betaN (or -rcN) release" for a development release. + * Define a new issue in the |projectRepo| repository to create the new release. -* For an official or development release, assign the issue to the corresponding |projectRepo| development project. + * "Create the |projectRepo| vX.Y.Z release" for an official or bugfix release. -* For a bugfix release, assign the issue to the organization level support project. + * "Create the |projectRepo| vX.Y.Z-betaN (or -rcN) release" for a development release. -* Select the target milestone. + * 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. + + * Select the target milestone. diff --git a/docs/Release_Guide/release_steps/rotate_authorship.rst b/docs/Release_Guide/release_steps/rotate_authorship.rst index bd7d57016c..64130d8f64 100644 --- a/docs/Release_Guide/release_steps/rotate_authorship.rst +++ b/docs/Release_Guide/release_steps/rotate_authorship.rst @@ -2,30 +2,32 @@ Rotate Authorship ^^^^^^^^^^^^^^^^^ The METplus team rotates the list of authors in the citation instructions -for each official release: +for each official release. -* Compare the current |projectRepo| User's Guide citation to the most recent - official release. +.. dropdown:: Instructions -* If needed, update the authorship order, moving the previous first author to - the end of the list. Note the format difference in the first name in the - citation list compared with the others. The first name in the citation list - is "Last name, First Initial." and all of the following names as - "First Initial. Last Name". Please maintain that format as it is the most - common format for citations. + * Compare the current |projectRepo| User's Guide citation to the most recent + official release. -* The author list is typically found in the conf.py file in the documentation - directory, i.e. *docs/conf.py*. - Most of the component repositories store the list of authors in a variable - named **author_list**. Please ensure that changes to this list match the - correct format listed above. - In the METplus repository, the conf.py file has variable named - CURRENT_AUTHORS that is a list of the authors to rotate. - To rotate, move the first item in the list to the end of the list. - There is logic in this file to read the list and format it properly to match - the expected format for citations. + * If needed, update the authorship order, moving the previous first author to + the end of the list. Note the format difference in the first name in the + citation list compared with the others. The first name in the citation list + is "Last name, First Initial." and all of the following names as + "First Initial. Last Name". Please maintain that format as it is the most + common format for citations. -* Review the list of authors in the citation and at the top level of the - documentation and update as needed. + * The author list is typically found in the conf.py file in the documentation + directory, i.e. *docs/conf.py*. + Most of the component repositories store the list of authors in a variable + named **author_list**. Please ensure that changes to this list match the + correct format listed above. + In the METplus repository, the conf.py file has variable named + CURRENT_AUTHORS that is a list of the authors to rotate. + To rotate, move the first item in the list to the end of the list. + There is logic in this file to read the list and format it properly to match + the expected format for citations. + + * Review the list of authors in the citation and at the top level of the + documentation and update as needed. -* Commit changes and push to GitHub + * Commit changes and push to GitHub diff --git a/docs/Release_Guide/release_steps/set_beta_deletion_reminder_official.rst b/docs/Release_Guide/release_steps/set_beta_deletion_reminder_official.rst index bf60ed0ea2..0b8fbc188c 100644 --- a/docs/Release_Guide/release_steps/set_beta_deletion_reminder_official.rst +++ b/docs/Release_Guide/release_steps/set_beta_deletion_reminder_official.rst @@ -1,12 +1,16 @@ -Set up Reminder to Delete Beta/RC Tags and Releases -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Help keep the GitHub repositories and DockerHub clean by removing -beta/rc tags and releases. -Do not delete the tags/releases for this release right away. Please set a -calendar reminder or schedule an email to be sent two weeks from the release -date as a reminder to delete the tags/releases. - -In GitHub, first delete all of the releases that contain beta or rc in the name, -then delete all corresponding tags. -Delete any beta/rc tags in DockerHub if applicable. +Create a Reminder to Delete Stale Releases +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Two weeks after the official release, remove stale development tags and releases. + +.. dropdown:: Instructions + + Help keep the GitHub repositories and DockerHub clean by removing + beta/rc tags and releases created during development for this official release. + Do not delete the tags/releases for this release right away. Please set a + calendar reminder or schedule an email to be sent two weeks from the release + date as a reminder to delete the tags/releases. + + In GitHub, first delete all of the releases that contain beta or rc in the name, + then delete all corresponding tags. + Delete any beta/rc tags in DockerHub if applicable. diff --git a/docs/Release_Guide/release_steps/update_docs_official.rst b/docs/Release_Guide/release_steps/update_docs_official.rst index d29d9cb3a9..7330b7a3d7 100644 --- a/docs/Release_Guide/release_steps/update_docs_official.rst +++ b/docs/Release_Guide/release_steps/update_docs_official.rst @@ -1,27 +1,29 @@ Update the Documentation on the Web ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Because Read the Docs is configured to automate the building of new "main" -branches in the METplus components' repositories, nothing needs to be done -to build the documentation for the new release. See the -:ref:`Read the Docs section ` for further information. -For an official release, it is important to update the "Default branch" to -this latest "main" branch. An administrator of the METplus component -repository will need to do the following to update the default branch: +Update the default branch for Read the Docs. - * Log into their Read the Docs account +.. dropdown:: Instructions + + Because Read the Docs is configured to automate the building of new "main" + branches in the METplus components' repositories, nothing needs to be done + to build the documentation for the new release. See the + :ref:`Read the Docs section ` for further information. + For an official release, it is important to update the "Default branch" to + this latest "main" branch. An administrator of the METplus component + repository will need to do the following to update the default branch: + + * Log into their Read the Docs account - * Click on the appropriate METplus component project + * Click on the appropriate METplus component project - * Click on Settings in the top right menu + * Click on Settings in the top right menu - * Select the new default branch in the dropdown menu for "Default branch" - (e.g. main_v4.0.0) and click the Save button at the bottom of the page - - * Ensure that "latest" points to the new default branch by clicking on - "latest" build that just started and click on "Version latest" to view the - build run. When it finishes running, click on "View Docs" on the right of - the page and confirm that the version number - displayed in the header is the desired version for "latest". + * Select the new default branch in the dropdown menu for "Default branch" + (e.g. main_v4.0.0) and click the Save button at the bottom of the page - + * Ensure that "latest" points to the new default branch by clicking on + "latest" build that just started and click on "Version latest" to view the + build run. When it finishes running, click on "View Docs" on the right of + the page and confirm that the version number + displayed in the header is the desired version for "latest". diff --git a/docs/Release_Guide/release_steps/update_release_notes_bugfix.rst b/docs/Release_Guide/release_steps/update_release_notes_bugfix.rst index bbdebb7680..e1aa715b5c 100644 --- a/docs/Release_Guide/release_steps/update_release_notes_bugfix.rst +++ b/docs/Release_Guide/release_steps/update_release_notes_bugfix.rst @@ -1,43 +1,47 @@ Update Release Notes ^^^^^^^^^^^^^^^^^^^^ -You can refer to the GitHub Project board to see what has changed for this -release. Open the following URL in a browser: +Update the release notes for this release. -.. parsed-literal:: +.. dropdown:: Instructions - https://github.com/orgs/dtcenter/projects + You can refer to the GitHub Project board to see what has changed for this + release. Open the following URL in a browser: -* Click on the project that corresponds to support for the release, i.e. - METplus Version X.Y Support + .. parsed-literal:: -* Navigate to the "Closed Issues" tab. If this tab does not exist, - see :ref:`wo-support-project` to create it. + https://github.com/orgs/dtcenter/projects -* Find the closed issues with dtcenter/|projectRepo| in the Repository column - that have been added since the last bugfix release for |projectRepo|. + * Click on the project that corresponds to support for the release, i.e. + METplus Version X.Y Support -* Open the following URL in a browser: + * Navigate to the "Closed Issues" tab. If this tab does not exist, + see :ref:`wo-support-project` to create it. -.. parsed-literal:: + * Find the closed issues with dtcenter/|projectRepo| in the Repository column + that have been added since the last bugfix release for |projectRepo|. - https://github.com/dtcenter/|projectRepo|/issues + * Open the following URL in a browser: -* Navigate to the |projectRepo| X.Y.Z Milestone to check for any issues - that may not appear in the METplus Version X.Y Support project board. + .. parsed-literal:: -* Update the release-notes.rst file found in the User's Guide directory. + https://github.com/dtcenter/|projectRepo|/issues -* Consider organizing release notes into logical groups - (e.g. Enhancements, Bugfixes, Documentation, etc.) and modifying - GitHub issue titles for consistency. The release notes should match - the GitHub issue titles, when possible. + * Navigate to the |projectRepo| X.Y.Z Milestone to check for any issues + that may not appear in the METplus Version X.Y Support project board. + + * Update the release-notes.rst file found in the User's Guide directory. + + * Consider organizing release notes into logical groups + (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. + * Use your best judgement to apply bold formatting for any major or important changes. -* When creating a bugfix release, leave the "Version X.Y.0 release notes - (YYYYMMDD)" in place, along with any other bugfix release notes and - add a section above for the latest bugfix release (i.e. "Version X.Y.Z - release notes (YYYYMMDD)"). + * When creating a bugfix release, leave the "Version X.Y.0 release notes + (YYYYMMDD)" in place, along with any other bugfix release notes and + add a section above for the latest bugfix release (i.e. "Version X.Y.Z + release notes (YYYYMMDD)"). -* Commit changes and push to GitHub. + * Commit changes and push to GitHub. diff --git a/docs/Release_Guide/release_steps/update_release_notes_development.rst b/docs/Release_Guide/release_steps/update_release_notes_development.rst index e546970ed9..4801a6f475 100644 --- a/docs/Release_Guide/release_steps/update_release_notes_development.rst +++ b/docs/Release_Guide/release_steps/update_release_notes_development.rst @@ -1,33 +1,37 @@ Update Release Notes ^^^^^^^^^^^^^^^^^^^^ -You can refer to the GitHub Project board to see what has changed for this -release. Open the following URL in a browser: +Update the release notes for this release. -.. parsed-literal:: +.. dropdown:: Instructions - https://github.com/orgs/dtcenter/projects + You can refer to the GitHub Project board to see what has changed for this + release. Open the following URL in a browser: -* Click on the project that corresponds to this release, i.e. - |projectRepo|-X.Y.Z Development + .. parsed-literal:: -* Navigate to the "Closed Issues" tab. If this tab does not exist, - see :ref:`wo-development-project` to create it. + https://github.com/orgs/dtcenter/projects -* Update the release-notes.rst file found in the User's Guide directory. + * Click on the project that corresponds to this release, i.e. + |projectRepo|-X.Y.Z Development -* Consider organizing release notes into logical groups - (e.g. Enhancements, Bugfixes, Documentation, etc.) and modifying - GitHub issue titles for consistency. The release notes should match - the GitHub issue titles, when possible. + * Navigate to the "Closed Issues" tab. If this tab does not exist, + see :ref:`wo-development-project` to create it. -* Use your best judgement to apply bold formatting for any major or important changes. + * Update the release-notes.rst file found in the User's Guide directory. -* 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)". + * Consider organizing release notes into logical groups + (e.g. Enhancements, Bugfixes, Documentation, etc.) and modifying + GitHub issue titles for consistency. The release notes should match + the GitHub issue titles, when possible. -* If you are creating a betaX release, add a new betaX section above the betaX-1 - release. + * Use your best judgement to apply bold formatting for any major or important changes. -* Commit changes and push to GitHub. + * 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. + + * Commit changes and push to GitHub. diff --git a/docs/Release_Guide/release_steps/update_release_notes_official.rst b/docs/Release_Guide/release_steps/update_release_notes_official.rst index b13a3438f4..d494d0ded0 100644 --- a/docs/Release_Guide/release_steps/update_release_notes_official.rst +++ b/docs/Release_Guide/release_steps/update_release_notes_official.rst @@ -1,33 +1,37 @@ Update Release Notes ^^^^^^^^^^^^^^^^^^^^ -You can refer to the GitHub Project board to see what has changed for this -release. Open the following URL in a browser: +Update the release notes for this release. -.. parsed-literal:: +.. dropdown:: Instructions - https://github.com/orgs/dtcenter/projects + You can refer to the GitHub Project board to see what has changed for this + release. Open the following URL in a browser: -* Click on the project that corresponds to this release, i.e. - |projectRepo|-X.Y.Z Development + .. parsed-literal:: -* Navigate to the "Closed Issues" tab. If this tab does not exist, - see :ref:`wo-development-project` to create it. + https://github.com/orgs/dtcenter/projects -* Update the release-notes.rst file found in the User's Guide directory. + * Click on the project that corresponds to this release, i.e. + |projectRepo|-X.Y.Z Development -* Consider organizing release notes into logical groups - (e.g. Enhancements, Bugfixes, Documentation, etc.) and modifying - GitHub issue titles for consistency. The release notes should match - the GitHub issue titles, when possible. + * Navigate to the "Closed Issues" tab. If this tab does not exist, + see :ref:`wo-development-project` to create it. -* Use your best judgement to apply bold formatting for any major or important changes. + * Update the release-notes.rst file found in the User's Guide directory. -* When creating the official release, combine the beta release sections - into one section (i.e. "Version X.Y.Z release notes (YYYYMMDD)"). + * Consider organizing release notes into logical groups + (e.g. Enhancements, Bugfixes, Documentation, etc.) and modifying + GitHub issue titles for consistency. The release notes should match + the GitHub issue titles, when possible. -* For the METplus repository, remove the **development timeline** information under the - `METplus Release Information `_ - section prior to creating the official release. + * Use your best judgement to apply bold formatting for any major or important changes. -* Commit changes and push to GitHub. + * 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 under the + `METplus Release Information `_ + section prior to creating the official release. + + * Commit changes and push to GitHub. diff --git a/docs/Release_Guide/release_steps/update_upgrade_instructions.rst b/docs/Release_Guide/release_steps/update_upgrade_instructions.rst index 4a8bf6c5a0..59e02f22f9 100644 --- a/docs/Release_Guide/release_steps/update_upgrade_instructions.rst +++ b/docs/Release_Guide/release_steps/update_upgrade_instructions.rst @@ -1,26 +1,30 @@ Update Upgrade Instructions ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Occasionally, changes will be made to software that will require users to make -changes to their configuration files in order to use the latest release. For -example, when ensemble post-processing was added to Gen-Ens-Prod and removed -from Ensemble-Stat, users were required to make changes in their configuration -files. +Update the upgrade instructions for this release. -.. note:: +.. dropdown:: Instructions - This section is not always applicable. + Occasionally, changes will be made to software that will require users to make + changes to their configuration files in order to use the latest release. For + example, when ensemble post-processing was added to Gen-Ens-Prod and removed + from Ensemble-Stat, users were required to make changes in their configuration + files. + .. note:: -To alert the users to the necessary steps involved with the upgrade: + This section is not always applicable. -* Update the Upgrade Instructions section of the release-notes.rst file found - in the |projectRepo| User's Guide directory with the necessary information. -* Add an "upgrade instructions" link next to the appropriate METplus component - (|projectRepo|) after "latest" and before "development" in - the :ref:`METplus Components Release Note Links ` - section in the release-notes.rst file in the METplus User's Guide in the - `METplus GitHub repository `__ ONLY - if there are Upgrade Instructions for this release. + To alert the users to the necessary steps involved with the upgrade: + + * Update the Upgrade Instructions section of the release-notes.rst file found + in the |projectRepo| User's Guide directory with the necessary information. + + * Add an "upgrade instructions" link next to the appropriate METplus component + (|projectRepo|) after "latest" and before "development" in + the :ref:`METplus Components Release Note Links ` + section in the release-notes.rst file in the METplus User's Guide in the + `METplus GitHub repository `__ ONLY + if there are Upgrade Instructions for this release. diff --git a/docs/Users_Guide/glossary.rst b/docs/Users_Guide/glossary.rst index e370857fbd..b044cc499d 100644 --- a/docs/Users_Guide/glossary.rst +++ b/docs/Users_Guide/glossary.rst @@ -8933,6 +8933,11 @@ METplus Configuration Glossary | *Used by:* SeriesAnalysis + SERIES_ANALYSIS_OUTPUT_STATS_GRAD + Specify the value for 'output_stats.grad' in the MET configuration file for SeriesAnalysis. + + | *Used by:* SeriesAnalysis + MODE_PS_PLOT_FLAG Specify the value for 'ps_plot_flag' in the MET configuration file for MODE. @@ -13313,3 +13318,23 @@ METplus Configuration Glossary See :term:`INPUT_THRESH` for details. | *Used by:* WaveletStat + + GRID_STAT_GRADIENT_DX + Specify the value for 'gradient.dx' in the MET configuration file for GridStat. + + | *Used by:* GridStat + + GRID_STAT_GRADIENT_DY + Specify the value for 'gradient.dy' in the MET configuration file for GridStat. + + | *Used by:* GridStat + + SERIES_ANALYSIS_GRADIENT_DX + Specify the value for 'gradient.dx' in the MET configuration file for SeriesAnalysis. + + | *Used by:* SeriesAnalysis + + SERIES_ANALYSIS_GRADIENT_DY + Specify the value for 'gradient.dy' in the MET configuration file for SeriesAnalysis. + + | *Used by:* SeriesAnalysis diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 8ebbccc09e..c2adf8d5bf 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -105,7 +105,7 @@ Please create a post in the `METplus GitHub Discussions Forum `_ with any questions. -Code support +User support ============ Support for METplus Wrappers is provided through the diff --git a/docs/Users_Guide/wrappers.rst b/docs/Users_Guide/wrappers.rst index 2218a9fe0a..0d2c50ff5a 100644 --- a/docs/Users_Guide/wrappers.rst +++ b/docs/Users_Guide/wrappers.rst @@ -3416,6 +3416,8 @@ METplus Configuration | :term:`GRID_STAT_TIME_OFFSET_WARNING` | :term:`GRID_STAT_ALLOW_MISSING_INPUTS` | :term:`GRID_STAT_INPUT_THRESH` +| :term:`GRID_STAT_GRADIENT_DX` +| :term:`GRID_STAT_GRADIENT_DY` | .. warning:: **DEPRECATED** @@ -3922,6 +3924,20 @@ ${METPLUS_FOURIER_DICT} * - :term:`GRID_STAT_FOURIER_WAVE_1D_END` - fourier.wave_1d_end +${METPLUS_GRADIENT_DICT} +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. list-table:: + :widths: 5 5 + :header-rows: 1 + + * - METplus Config(s) + - MET Config File + * - :term:`GRID_STAT_GRADIENT_DX` + - gradient.dx + * - :term:`GRID_STAT_GRADIENT_DY` + - gradient.dy + ${METPLUS_DISTANCE_MAP_DICT} """""""""""""""""""""""""""" @@ -8135,6 +8151,7 @@ METplus Configuration | :term:`SERIES_ANALYSIS_OUTPUT_STATS_PSTD` | :term:`SERIES_ANALYSIS_OUTPUT_STATS_PJC` | :term:`SERIES_ANALYSIS_OUTPUT_STATS_PRC` +| :term:`SERIES_ANALYSIS_OUTPUT_STATS_GRAD` | :term:`FCST_SERIES_ANALYSIS_CAT_THRESH` | :term:`OBS_SERIES_ANALYSIS_CAT_THRESH` | :term:`FCST_SERIES_ANALYSIS_IS_PROB` @@ -8148,6 +8165,8 @@ METplus Configuration | :term:`SERIES_ANALYSIS_TIME_OFFSET_WARNING` | :term:`SERIES_ANALYSIS_ALLOW_MISSING_INPUTS` | :term:`SERIES_ANALYSIS_INPUT_THRESH` +| :term:`SERIES_ANALYSIS_GRADIENT_DX` +| :term:`SERIES_ANALYSIS_GRADIENT_DY` | .. warning:: **DEPRECATED:** @@ -8554,6 +8573,20 @@ ${METPLUS_MASK_DICT} * - :term:`SERIES_ANALYSIS_MASK_POLY` - mask.poly +${METPLUS_GRADIENT_DICT} +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. list-table:: + :widths: 5 5 + :header-rows: 1 + + * - METplus Config(s) + - MET Config File + * - :term:`SERIES_ANALYSIS_GRADIENT_DX` + - gradient.dx + * - :term:`SERIES_ANALYSIS_GRADIENT_DY` + - gradient.dy + ${METPLUS_BLOCK_SIZE} """"""""""""""""""""" @@ -8611,6 +8644,8 @@ ${METPLUS_OUTPUT_STATS_DICT} - output_stats.pjc * - :term:`SERIES_ANALYSIS_OUTPUT_STATS_PRC` - output_stats.prc + * - :term:`SERIES_ANALYSIS_OUTPUT_STATS_GRAD` + - output_stats.grad ${METPLUS_HSS_EC_VALUE} """"""""""""""""""""""" diff --git a/docs/_static/pop_ver.js b/docs/_static/pop_ver.js deleted file mode 100644 index ed70d7d141..0000000000 --- a/docs/_static/pop_ver.js +++ /dev/null @@ -1,18 +0,0 @@ -$(document).ready(function() { - // Add 8 to get to end of URL METplus/ - var proj_end = document.baseURI.indexOf("METplus") + 8; - var end = document.baseURI.indexOf("/", proj_end); - var cur_ver = document.baseURI.substring(proj_end, end); - var name = cur_ver.startsWith('v') ? cur_ver.substring(1) : cur_ver; - var mylist = $("#version-list"); - mylist.empty(); - mylist.append($("