From e9102f8de35976289767b66cda8073dfdaef374b Mon Sep 17 00:00:00 2001 From: bikegeek Date: Tue, 17 Dec 2024 16:35:07 -0700 Subject: [PATCH 1/6] updates for coordinated release: version updates, dates, rotating authors --- docs/Users_Guide/release-notes.rst | 149 ++--------------------------- docs/conf.py | 4 +- 2 files changed, 12 insertions(+), 141 deletions(-) diff --git a/docs/Users_Guide/release-notes.rst b/docs/Users_Guide/release-notes.rst index d86a300d..6d74caae 100644 --- a/docs/Users_Guide/release-notes.rst +++ b/docs/Users_Guide/release-notes.rst @@ -10,7 +10,7 @@ describes the bugfix, enhancement, or new feature: METplotpy Release Notes ======================= -METplotpy Version 3.0.0-rc1 release notes (20241114) +METplotpy Version 3.0.0 release notes (20241218) ------------------------------------------------------ .. dropdown:: New Plots @@ -20,170 +20,41 @@ METplotpy Version 3.0.0-rc1 release notes (20241114) .. dropdown:: Enhancements - None - - - - .. dropdown:: Internal - - None - - - .. dropdown:: Bugfixes - - None - - - -METplotpy Version 3.0.0-beta6 release notes (20241018) ------------------------------------------------------- - - .. dropdown:: New Plots - - None - - .. dropdown:: Enhancements - * Improve logging for STIGS on remaining plots (`METplus-Internal#57 `_) * Plot new TC-Diagnostics output from TC-Pairs (`#233 `_) - - .. dropdown:: Internal - - * Improve unit test infrastructure and coverage (`#461 `_) - - .. dropdown:: Bugfixes - - None - -METplotpy Version 3.0.0-beta5 release notes (20240630) ------------------------------------------------------- - - - .. dropdown:: New Plots - - - .. dropdown:: Enhancements - - * **Enhance TCMPR plotter to read TCDiag lines and filter by one column and plot another column** (`#342 `_). - * Create documentation and testing for TCMPR plotting code (`#383 `_). - * Update fv3_physics_tend for new FV3 output format (`#380 `_). - - .. dropdown:: Internal - - - * Update GitHub issue and pull request templates to reflect the current development workflow details (`#388 `_). - - * Consider using only .yml or only .yaml extensions (`#417 `_). - - * METplotpy:Code coverage statistics (`#55 `_). - - - .. dropdown:: Bugfixes - - -METplotpy Version 3.0.0-beta4 release notes (20240417) ------------------------------------------------------- - - .. dropdown:: New Plots - - - .. dropdown:: Enhancements - - * Update GitHub actions workflows to switch from node 16 to node 20 (`#414 `_). - * **Add GitHub action to run SonarQube for METplotpy pull requests and feature branches** (`#429 `_). - - - .. dropdown:: Internal - - - - .. dropdown:: Bugfixes - - - * **TC-RMW plot needs updating to support changes to input** (`#425 `_). - - - -METplotpy Version 3.0.0-beta3 release notes (20240206) ------------------------------------------------------- - - - .. dropdown:: New Plots - - - - .. dropdown:: Enhancements - - * **Add a summary curve to the ROC diagram** (`#399 `_). - - - .. dropdown:: Internal - - - - .. dropdown:: Bugfixes - - * TC-RMW plot needs updating to support changes to input (`#425 `_). - - - - -METplotpy Version 3.0.0-beta2 release notes (20231108) ------------------------------------------------------- - - .. dropdown:: New Plots - - - .. dropdown:: Enhancements - - * **hide/show the legend entries line-by-line** (`#355 `_). + * **specify the color of the no resolution and no skill lines for the reliability diagram** (`#329 `_). - * **specify the color of the no resolution and no skill lines for the reliability diagram** (`#329 `_). .. dropdown:: Internal + * Improve unit test infrastructure and coverage (`#461 `_) + * Update GitHub issue and pull request templates to reflect the current development workflow details (`#388 `_). + * Consider using only .yml or only .yaml extensions (`#417 `_). + * METplotpy:Code coverage statistics (`#55 `_). + .. dropdown:: Bugfixes + * **TC-RMW plot needs updating to support changes to input** (`#425 `_). + * TC-RMW plot needs updating to support changes to input (`#425 `_). * **Documentation-Fix METviewer link in line plot** (`#385 `_). - * **Inconsistency with generating plot in METviewer vs command line** (`#391 `_). - * **Bugfix for ROC plot image saving to file** (`#394 `_). - * Bugfix for erros in line and revision_series tests (`#401 `_). -METplotpy Version 3.0.0-beta1 release notes (20230915) ------------------------------------------------------- - - .. dropdown:: New Plots - - - .. dropdown:: Enhancements - - - .. dropdown:: Internal - - - .. dropdown:: Bugfixes - - - - METplotpy Upgrade Instructions ============================== -Upgrade instructions will be listed here if they are -applicable for this release. +None diff --git a/docs/conf.py b/docs/conf.py index d90a9f22..619b05de 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,13 +24,13 @@ project = 'METplotpy' copyright = '2024, NSF NCAR' author = 'UCAR/NSF NCAR, NOAA, CSU/CIRA, and CU/CIRES' -author_list = 'Fisher, H., D. Adriaansen, C. Kalb, D. Fillmore, T. Jensen, L. Goodrich, M. Win-Gildenmeister and T. Burek' +author_list = 'D. Adriaansen, D., C. Kalb, D. Fillmore, T. Jensen, L. Goodrich, M. Win-Gildenmeister, T. Burek, and H. Fisher' verinfo = version release = f'{version}' release_year = '2024' -release_date = f'{release_year}-11-14' +release_date = f'{release_year}-12-18' copyright = f'{release_year}, {author}' From 9e73b03bfb19707eeae117de8795810d6dc00237 Mon Sep 17 00:00:00 2001 From: bikegeek Date: Tue, 17 Dec 2024 16:47:15 -0700 Subject: [PATCH 2/6] Clean up text: fix typos, remove duplicates --- docs/Users_Guide/release-notes.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/Users_Guide/release-notes.rst b/docs/Users_Guide/release-notes.rst index 6d74caae..df46c511 100644 --- a/docs/Users_Guide/release-notes.rst +++ b/docs/Users_Guide/release-notes.rst @@ -24,7 +24,7 @@ METplotpy Version 3.0.0 release notes (20241218) * Plot new TC-Diagnostics output from TC-Pairs (`#233 `_) * **Enhance TCMPR plotter to read TCDiag lines and filter by one column and plot another column** (`#342 `_). * Create documentation and testing for TCMPR plotting code (`#383 `_). - * Update fv3_physics_tend for new FV3 output format (`#380 `_). + * Update fv3_physics_tend for new FV3 output format (`#380 `_). * Update GitHub actions workflows to switch from node 16 to node 20 (`#414 `_). * **Add GitHub action to run SonarQube for METplotpy pull requests and feature branches** (`#429 `_). * **Add a summary curve to the ROC diagram** (`#399 `_). @@ -37,19 +37,18 @@ METplotpy Version 3.0.0 release notes (20241218) * Improve unit test infrastructure and coverage (`#461 `_) * Update GitHub issue and pull request templates to reflect the current development workflow details (`#388 `_). - * Consider using only .yml or only .yaml extensions (`#417 `_). - * METplotpy:Code coverage statistics (`#55 `_). + * Consider using only .yml or only .yaml extensions (`#417 `_). + * METplotpy:Code coverage statistics (`#55 `_). .. dropdown:: Bugfixes - * **TC-RMW plot needs updating to support changes to input** (`#425 `_). * TC-RMW plot needs updating to support changes to input (`#425 `_). * **Documentation-Fix METviewer link in line plot** (`#385 `_). * **Inconsistency with generating plot in METviewer vs command line** (`#391 `_). * **Bugfix for ROC plot image saving to file** (`#394 `_). - * Bugfix for erros in line and revision_series tests (`#401 `_). + * Bugfix for errors in line and revision_series tests (`#401 `_). METplotpy Upgrade Instructions From f9f56af87fc8b2356aa44561d2809a4a1bd51d8d Mon Sep 17 00:00:00 2001 From: bikegeek <3753118+bikegeek@users.noreply.github.com> Date: Wed, 18 Dec 2024 15:28:31 -0700 Subject: [PATCH 3/6] Update vulnerabilities.yaml update gh-action-pip-audit from 1.0.5 to 1.1.0 --- .github/workflows/vulnerabilities.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vulnerabilities.yaml b/.github/workflows/vulnerabilities.yaml index 917074aa..6cbede66 100644 --- a/.github/workflows/vulnerabilities.yaml +++ b/.github/workflows/vulnerabilities.yaml @@ -28,7 +28,7 @@ jobs: python -m venv env/ source env/bin/activate python -m pip install . - - uses: pypa/gh-action-pip-audit@v1.0.5 + - uses: pypa/gh-action-pip-audit@v1.1.0 with: inputs: requirements.txt virtual-environment: env/ From de8bf48b959f2eeaacada5659315449019646084 Mon Sep 17 00:00:00 2001 From: bikegeek <3753118+bikegeek@users.noreply.github.com> Date: Wed, 18 Dec 2024 15:46:38 -0700 Subject: [PATCH 4/6] Apply suggestions from code review Co-authored-by: Julie Prestopnik --- docs/Users_Guide/release-notes.rst | 6 +++--- docs/conf.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/Users_Guide/release-notes.rst b/docs/Users_Guide/release-notes.rst index df46c511..4927f64a 100644 --- a/docs/Users_Guide/release-notes.rst +++ b/docs/Users_Guide/release-notes.rst @@ -28,8 +28,8 @@ METplotpy Version 3.0.0 release notes (20241218) * Update GitHub actions workflows to switch from node 16 to node 20 (`#414 `_). * **Add GitHub action to run SonarQube for METplotpy pull requests and feature branches** (`#429 `_). * **Add a summary curve to the ROC diagram** (`#399 `_). - * **hide/show the legend entries line-by-line** (`#355 `_). - * **specify the color of the no resolution and no skill lines for the reliability diagram** (`#329 `_). + * **Hide/show the legend entries line-by-line** (`#355 `_). + * **Specify the color of the no resolution and no skill lines for the reliability diagram** (`#329 `_). @@ -45,7 +45,7 @@ METplotpy Version 3.0.0 release notes (20241218) .. dropdown:: Bugfixes * TC-RMW plot needs updating to support changes to input (`#425 `_). - * **Documentation-Fix METviewer link in line plot** (`#385 `_). + * **Documentation - Fix METviewer link in line plot** (`#385 `_). * **Inconsistency with generating plot in METviewer vs command line** (`#391 `_). * **Bugfix for ROC plot image saving to file** (`#394 `_). * Bugfix for errors in line and revision_series tests (`#401 `_). diff --git a/docs/conf.py b/docs/conf.py index 619b05de..c74b0fb9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,7 +24,7 @@ project = 'METplotpy' copyright = '2024, NSF NCAR' author = 'UCAR/NSF NCAR, NOAA, CSU/CIRA, and CU/CIRES' -author_list = 'D. Adriaansen, D., C. Kalb, D. Fillmore, T. Jensen, L. Goodrich, M. Win-Gildenmeister, T. Burek, and H. Fisher' +author_list = 'Adriaansen, D., C. Kalb, D. Fillmore, T. Jensen, L. Goodrich, M. Win-Gildenmeister, T. Burek, and H. Fisher' verinfo = version release = f'{version}' From 16981d88eb6028e5c06ae0b47ff7ec461dcd31cc Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Wed, 18 Dec 2024 15:59:17 -0700 Subject: [PATCH 5/6] Adding space --- docs/Users_Guide/release-notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Users_Guide/release-notes.rst b/docs/Users_Guide/release-notes.rst index 4927f64a..c39f841a 100644 --- a/docs/Users_Guide/release-notes.rst +++ b/docs/Users_Guide/release-notes.rst @@ -38,7 +38,7 @@ METplotpy Version 3.0.0 release notes (20241218) * Improve unit test infrastructure and coverage (`#461 `_) * Update GitHub issue and pull request templates to reflect the current development workflow details (`#388 `_). * Consider using only .yml or only .yaml extensions (`#417 `_). - * METplotpy:Code coverage statistics (`#55 `_). + * METplotpy: Code coverage statistics (`#55 `_). From 687dfa90e460a8dca6d8dcbfd2e40bc52952b225 Mon Sep 17 00:00:00 2001 From: bikegeek Date: Wed, 18 Dec 2024 16:00:17 -0700 Subject: [PATCH 6/6] Removing, superfluous since vulnerability checks are automatically done --- .github/workflows/vulnerabilities.yaml | 36 -------------------------- 1 file changed, 36 deletions(-) delete mode 100644 .github/workflows/vulnerabilities.yaml diff --git a/.github/workflows/vulnerabilities.yaml b/.github/workflows/vulnerabilities.yaml deleted file mode 100644 index 6cbede66..00000000 --- a/.github/workflows/vulnerabilities.yaml +++ /dev/null @@ -1,36 +0,0 @@ -# This workflow will check third-party Python packages for vulnerabilities using pip-audit. -# pip-audit finds vulnerabilities from packages that are dependencies of -# the packages in the requirements.txt file. A summary is generated at the end of the action. -# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions - -name: Python vulnerability check - -on: - push: - branches: - - develop - - develop-ref - - feature_* - - main_* - - bugfix_* - - test_* - - issue_* - pull_request: - types: [opened, reopened, synchronize] - -jobs: - selftest: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - name: install - run: | - python -m venv env/ - source env/bin/activate - python -m pip install . - - uses: pypa/gh-action-pip-audit@v1.1.0 - with: - inputs: requirements.txt - virtual-environment: env/ - local: true - summary: true