Skip to content

Commit

Permalink
Update Develop-ref after dtcenter/MET#1967 (#1281)
Browse files Browse the repository at this point in the history
Co-authored-by: George McCabe <[email protected]>
Co-authored-by: Julie Prestopnik <[email protected]>
Co-authored-by: TaraJensen <[email protected]>
Co-authored-by: bikegeek <[email protected]>
Co-authored-by: bikegeek <[email protected]>
Co-authored-by: johnhg <[email protected]>
Co-authored-by: Christina Kalb <[email protected]>
Co-authored-by: lisagoodrich <[email protected]>
Co-authored-by: jprestop <[email protected]>
  • Loading branch information
9 people authored Nov 19, 2021
1 parent fe65296 commit 71c08b2
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 3 deletions.
54 changes: 52 additions & 2 deletions docs/Release_Guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,60 @@
Release Guide
=============

This METplus Release Guide provides detailed instructions for creating software releases from the METplus component repositories.
This METplus Release Guide provides detailed instructions for METplus
developers for creating software releases for the METplus component
repositories. **This Release Guide is intended for developers creating
releases and is not intended for users of the software.**

.. _releaseCycleStages:

Stages of the METplus Release Cycle
===================================

Development Release
-------------------

Beta
^^^^

Beta releases are a pre-release of the software to give a larger group of
users the opportunity to test the recently incorporated new features,
enhancements, and bug fixes. Beta releases allow for continued
development and bug fixes before an official release. There are many
possible configurations of hardware and software that exist and installation
of beta releases allow for testing of potential conflicts.

Release Candidate (rc)
^^^^^^^^^^^^^^^^^^^^^^

A release candidate is a version of the software that is nearly ready for
official release but may still have a few bugs. At this stage, all product
features have been designed, coded, and tested through one or more beta
cycles with no known bugs. It is code complete, meaning that no entirely
new source code will be added to this release. There may still be source
code changes to fix bugs, changes to documentation, and changes to test
cases or utilities.

Official Release
----------------

An official release is a stable release and is basically the release
candidate, which has passed all tests. It is the version of the code that
has been tested as thoroughly as possible and is reliable enough to be
used in production.

Bugfix Release
--------------

A bugfix release introduces no new features, but fixes bugs in previous
official releases and targets the most critical bugs affecting users.

Instructions Summary
====================

Instructions are provided for three types of software releases:

#. **Official Release** (e.g. vX.Y.Z) from the develop branch
#. **Official Release** (e.g. vX.Y.Z) from the develop branch (becomes the new main_vX.Y branch)

#. **Bugfix Release** (e.g. vX.Y.Z) from the corresponding main_vX.Y branch

Expand Down
31 changes: 31 additions & 0 deletions docs/Users_Guide/release-notes.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
METplus Release Notes
=====================

Users can view the :ref:`releaseCycleStages` section of
the Release Guide for descriptions of the development releases (including
beta releases and release candidates), official releases, and bugfix
releases for the METplus Components.

METplus Components Release Note Links
-------------------------------------

Expand Down Expand Up @@ -33,6 +38,32 @@ When applicable, release notes are followed by the GitHub issue number which
describes the bugfix, enhancement, or new feature:
https://github.com/dtcenter/METplus/issues

METplus Version 4.1.0-beta4 Release Notes (2021-11-16)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* Enhancements:

* **Create an Amazon AMI containing all METplus components** (`#506 <https://github.com/dtcenter/METplus/issues/506>`_)
* Added support for setting a dictionary value for time_summary.width (`#1252 <https://github.com/dtcenter/METplus/issues/1252>`_)
* Added support for setting obs_quality_inc/exc in PointStat (`#1213 <https://github.com/dtcenter/METplus/issues/1213>`_)
* Properly handle list values that include square braces (`#1212 <https://github.com/dtcenter/METplus/issues/1212>`_)
* Reorganize the Cryosphere and Marine and Coastal use case categories into one group (`#1200 <https://github.com/dtcenter/METplus/issues/1200>`_)
* Update wrapped MET config files to reference MET_TMP_DIR in tmp value (`#1101 <https://github.com/dtcenter/METplus/issues/1101>`_)
* CyclonePlotter, create options to format output grid area to user-desired area (`#1091 <https://github.com/dtcenter/METplus/issues/1091>`_)
* CyclonePlotter, connected lines run over the Prime Meridian (`#1000 <https://github.com/dtcenter/METplus/issues/1000>`_)
* Add harmonic pre-processing to the RMM use case (`#1019 <https://github.com/dtcenter/METplus/issues/1019>`_)

* New Wrappers:

* **IODA2NC** (`#1203 <https://github.com/dtcenter/METplus/issues/1203>`_)
* **GenEnsProd** (`#1180 <https://github.com/dtcenter/METplus/issues/1180>`_, `#1266 <https://github.com/dtcenter/METplus/issues/1266>`_)

* New Use Cases:

* **IODA2NC** (`#1204 <https://github.com/dtcenter/METplus/issues/1204>`_)
* **GenEnsProd** (`#1180 <https://github.com/dtcenter/METplus/issues/1180>`_, `#1266 <https://github.com/dtcenter/METplus/issues/1266>`_)


METplus Version 4.1.0-beta3 Release Notes (2021-10-06)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
2 changes: 1 addition & 1 deletion metplus/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
4.1.0-beta4-dev
4.1.0-beta5-dev

0 comments on commit 71c08b2

Please sign in to comment.