Skip to content

Commit

Permalink
Per #2844, more dropdowns.
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnHalleyGotway committed Dec 19, 2024
1 parent 1e8a0c9 commit 2132711
Show file tree
Hide file tree
Showing 19 changed files with 176 additions and 126 deletions.
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 10 additions & 6 deletions docs/Release_Guide/release_steps/coordinated/update_zenodo.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
Update Zenodo
-------------

In the `METplus GitHub repository <https://github.com/dtcenter/METplus>`_
scroll down to the README file and check the
`METplus Coordinated Release Digital Object Identifier (DOI) <https://doi.org/10.5281/zenodo.5567804>`_
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 <https://github.com/dtcenter/METplus>`_
scroll down to the README file and check the
`METplus Coordinated Release Digital Object Identifier (DOI) <https://doi.org/10.5281/zenodo.5567804>`_
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.
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -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 <update_version_official>` 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 <update_version_official>` 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.
Original file line number Diff line number Diff line change
@@ -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.



Original file line number Diff line number Diff line change
@@ -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** |
+-------------------+----------------------------+
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -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 <update_version_official>` 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 <update_version_official>` 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'.
Original file line number Diff line number Diff line change
@@ -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.

Original file line number Diff line number Diff line change
@@ -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** |
+-------------------+----------------------------+
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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 <update_version_official>` 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 <update_version_official>` 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.
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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** |
+-------------------+----------------------------+
Original file line number Diff line number Diff line change
@@ -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** |
+-------------------+----------------------------+
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -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 <update_version_official>` 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 <update_version_official>` 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.
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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.

Loading

0 comments on commit 2132711

Please sign in to comment.