Feature 418 v3.0.0 (#419)

* Combined beta release sections under one section * Updated version, date, author rotation * Added 'None' to update instructions * Update release-notes.rst changing date to 18th since GHA are very slow and unlikely to get release done by today * Update conf.py changing date from 17th to 18th, unlikely release will get finished today due to slow GHAs * Update vulnerabilities.yaml update version to 1.1.0 * Apply suggestions from code review Co-authored-by: Julie Prestopnik <[email protected]> --------- Co-authored-by: Julie Prestopnik <[email protected]>
dtcenter · Dec 18, 2024 · 5674017 · 5674017
1 parent 9d10ff5
commit 5674017
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 122 deletions.
diff --git 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/

diff --git a/docs/Users_Guide/release-notes.rst b/docs/Users_Guide/release-notes.rst
@@ -8,149 +8,47 @@ describes the bugfix, enhancement, or new feature: `METcalcpy GitHub issues. <ht
 METcalcpy Release Notes
 =======================
 
-METcalcpy Velsion 3.0.0-rc1 release notes (20241113)
+METcalcpy Velsion 3.0.0 release notes (20241218)
 ----------------------------------------------------
 
-  .. dropdown:: New Functionality
-
-     None
-
-  .. dropdown:: Enhancements
-
-     None
-
-  .. dropdown:: Internal
-
-     None
-
-  .. dropdown:: Bugfixes
-
-     None
-
-
-METcalcpy Velsion 3.0.0-beta6 release notes (20241018)
-------------------------------------------------------
-
-  .. dropdown:: New Functionality
-
-     None
-
-  .. dropdown:: Enhancements
-
-     * Improve logging for 5 STIGs (`METplus-Internal#46 <https://github.com/dtcenter/METplus-Internal/issues/46>`_)
-
-  .. dropdown:: Internal
-
-     None
-
-  .. dropdown:: Bugfixes
-
-     * Bugfix: MODE CSI calculations result in spurious results (`#360 <https://github.com/dtcenter/METcalcpy/issues/360>`_)
-
-
-METcalcpy Velsion 3.0.0-beta5 release notes (20240628)
-------------------------------------------------------
-
 
   .. dropdown:: New Functionality
 
      * **Add updates to MPR writer and fix bugs for stratosphere** (`#385 <https://github.com/dtcenter/METcalcpy/issues/385>`_)
 
   .. dropdown:: Enhancements
 
+     * Improve logging for 5 STIGs (`METplus-Internal#46 <https://github.com/dtcenter/METplus-Internal/issues/46>`_)
      * **Enhance METcalcpy to use the TOTAL_DIR column when aggregate statistics wind direction statistics in the VL1L2, VAL1L2, and VCNT columns** (`#384 <https://github.com/dtcenter/METcalcpy/issues/384>`_)
-
-  .. dropdown:: Internal
-
-     * Update GitHub issue and pull request templates to reflect the current development workflow details  (`#326 <https://github.com/dtcenter/METcalcpy/issues/326>`_)
-     * Consider using only .yml or only .yaml extensions  (`#349 <https://github.com/dtcenter/METcalcpy/issues/349>`_)
-     * Code coverage statistics  (`#54 <https://github.com/dtcenter/METplus-Internal/issues/54>`_)
-
-
-  .. dropdown:: Bugfixes
-
-
-METcalcpy Velsion 3.0.0-beta4 release notes (20240417)
-------------------------------------------------------
-
-
-  .. dropdown:: New Functionality
-
-
-  .. dropdown:: Enhancements
-
      * Add calculation for Terrestrial Coupling Index (`#364 <https://github.com/dtcenter/METcalcpy/issues/364>`_)
      * Enhance aggregate statistics for ECNT,VL1L2,VAL1L2 and VCNT (`#361 <https://github.com/dtcenter/METcalcpy/issues/361>`_)
-
-
-  .. dropdown:: Internal
-
-     * Develop sonarqube capabilities  (`#367 <https://github.com/dtcenter/METcalcpy/issues/367>`_)
-     * Add github action for sonarqube   (`#366 <https://github.com/dtcenter/METcalcpy/issues/366>`_)
-     * Updated pythoh requirements.txt   (`#355 <https://github.com/dtcenter/METcalcpy/issues/355>`_)
-     * Modified python requirements section of Users Guide   (`#352 <https://github.com/dtcenter/METcalcpy/issues/352>`_)
-
-
-  .. dropdown:: Bugfixes
-
-
-     * Address negative values returned by calculate_bcmse() and calculate_bcrmse() in sl1l2_statistics module (`#329 <https://github.com/dtcenter/METcalcpy/issues/329>`_)
-
-METcalcpy Velsion 3.0.0-beta3 release notes (20240207)
-------------------------------------------------------
-
-
-  .. dropdown:: New Functionality
-
-
-  .. dropdown:: Enhancements
-
      * **Create aggregation support for MET .stat output** (`#325 <https://github.com/dtcenter/METcalcpy/issues/325>`_)
 
-
   .. dropdown:: Internal
 
+     * Update GitHub issue and pull request templates to reflect the current development workflow details  (`#326 <https://github.com/dtcenter/METcalcpy/issues/326>`_)
+     * Consider using only .yml or only .yaml extensions  (`#349 <https://github.com/dtcenter/METcalcpy/issues/349>`_)
+     * Code coverage statistics  (`#54 <https://github.com/dtcenter/METplus-Internal/issues/54>`_)
+     * Develop SonarQube capabilities  (`#367 <https://github.com/dtcenter/METcalcpy/issues/367>`_)
+     * Add GitHub action for SonarQube   (`#366 <https://github.com/dtcenter/METcalcpy/issues/366>`_)
+     * Updated Python requirements.txt   (`#355 <https://github.com/dtcenter/METcalcpy/issues/355>`_)
+     * Modified Python requirements section of User's Guide   (`#352 <https://github.com/dtcenter/METcalcpy/issues/352>`_)
      * Update GitHub actions workflows to switch from node 16 to node 20  (`#345 <https://github.com/dtcenter/METcalcpy/issues/345>`_)
-
-
-  .. dropdown:: Bugfixes
-
-
-     * Address negative values returned by calculate_bcmse() and calculate_bcrmse() in sl1l2_statistics module (`#329 <https://github.com/dtcenter/METcalcpy/issues/329>`_)
-
-
-METcalcpy Velsion 3.0.0-beta2 release notes (20231114)
-------------------------------------------------------
-
-  .. dropdown:: New Functionality
-
-  .. dropdown:: Enhancements
-
-  .. dropdown:: Internal
-
      * Change second person references to third (`#315 <https://github.com/dtcenter/METcalcpy/issues/315>`_)
      * Enhanced documentation for Difficulty index (`#332 <https://github.com/dtcenter/METcalcpy/issues/332>`_)
 
   .. dropdown:: Bugfixes
-
+
+     * Bugfix missing safe_log import (`#413 <https://github.com/dtcenter/METcalcpy/issues/413>`_)
+     * Bugfix: MODE CSI calculations result in spurious results (`#360 <https://github.com/dtcenter/METcalcpy/issues/360>`_)
+     * Address negative values returned by calculate_bcmse() and calculate_bcrmse() in sl1l2_statistics module (`#329 <https://github.com/dtcenter/METcalcpy/issues/329>`_)
+     * Address negative values returned by calculate_bcmse() and calculate_bcrmse() in sl1l2_statistics module (`#329 <https://github.com/dtcenter/METcalcpy/issues/329>`_)
      * Add missing reliability statistics (`#330 <https://github.com/dtcenter/METcalcpy/issues/330>`_)
-
-METcalcpy Version 3.0.0-beta1 release notes (20230915)
-------------------------------------------------------
-
-  .. dropdown:: New Functionality
-
-  .. dropdown:: Enhancements
-
-  .. dropdown:: Internal
-
-  .. dropdown:: Bugfixes
-
      * Remove reset_index from various calculations (`#322 <https://github.com/dtcenter/METcalcpy/issues/322>`_)
 
 
 METcalcpy 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
@@ -21,12 +21,12 @@
 project = 'METcalcpy'
 copyright = '2024, NCAR'
 author = 'UCAR/NCAR, NOAA, CSU/CIRA, and CU/CIRES'
-author_list = 'Fisher, H., C. Kalb, D. Adriaansen, D. Fillmore, M. Win-Gildenmeister, T. Burek, M. Smith, and T. Jensen'
-version = '3.0.0-rc1'
+author_list = 'Kalb, C., D. Adriaansen, D. Fillmore, M. Win-Gildenmeister, T. Burek, M. Smith, T. Jensen, and H. Fisher'
+version = '3.0.0'
 verinfo = version
 release = f'{version}'
 release_year = '2024'
-release_date = f'{release_year}-11-13'
+release_date = f'{release_year}-12-18'
 copyright = f'{release_year}, {author}'
 
 # if set, adds "Last updated on " followed by