Skip to content

Commit

Permalink
Per #2282, add hooks for coordinated release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnHalleyGotway committed Aug 2, 2023
1 parent c1bb9ba commit 0f2a11b
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 26 deletions.
7 changes: 7 additions & 0 deletions docs/Release_Guide/coordinated.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
********************
Coordindated Release
********************

.. |projectRepo| replace:: Coordinated

Create a new METplus coordinated release from vX.Y.Z official releases for each METplus component.
60 changes: 34 additions & 26 deletions docs/Release_Guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,32 @@ releases and is not intended for users of the software.**
Stages of the METplus Release Cycle
===================================

Coordinated Release
-------------------

A coordinated release is a group of official or bugfix releases for each
of the METplus components that have been developed and tested in parallel.
Coordinated release announcements on the
`DTC METplus Downloads <https://dtcenter.org/community-code/metplus/download>`_
page link to the component releases that comprise the coordinated release.
When bugfix releases are issued for any METplus component, the corresponding
coordinated release announcement is updated to link to the most recent bugfix
version.

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.

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

Expand All @@ -36,20 +62,6 @@ 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.

Release Support Policy
======================

Expand All @@ -68,24 +80,28 @@ to report any bugs, please contact our dedicated support team in the
Instructions Summary
====================

Instructions are provided for three types of software releases:
Instructions are provided for the following types of software releases:

#. **Coordinated Release** consisting of a group of software component releases

#. **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

#. **Development Release** (e.g. vX.Y.Z-betaN or vX.Y.Z-rcN) from the develop branch

The instructions that are common to all components are documented only once and then included in the release steps for all components.
However some instructions are specific to individual repositories and documented separately.
The instructions that are common to all components are documented only once and then included
in the release steps for all components. However some instructions are specific to individual
repositories and documented separately.

Release instructions for each of the METplus components are described in the following chapters.
Release instructions are described in the following chapters.

.. toctree::
:titlesonly:
:maxdepth: 1
:numbered: 4

coordinated
metplus
met
metdataio
Expand All @@ -94,11 +110,3 @@ Release instructions for each of the METplus components are described in the fol
metviewer
metexpress
recreate_release


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

0 comments on commit 0f2a11b

Please sign in to comment.