Skip to content

Commit

Permalink
Per 673, work on met bugfix release instructions. This is a work in p…
Browse files Browse the repository at this point in the history
…rogress.
  • Loading branch information
JohnHalleyGotway committed Nov 18, 2020
1 parent e5fff86 commit 303b35a
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/Release_Guide/met.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,17 @@ Bugfix release (e.g. vX.Y.Z)

.. include:: release_steps/clone_project_repository.rst
.. include:: release_steps/checkout_main_branch.rst
.. include:: release_steps/met/update_version.rst

TODO: keep working here

.. include:: release_steps/metplus/update_docs_bugfix.rst
.. include:: release_steps/create_release_on_github.rst
.. include:: release_steps/metplus/create_release_extra.rst

Development release (e.g. vX.Y-betaN or vX.Y-rcN)
=================================================

.. include:: release_steps/clone_project_repository.rst
.. include:: release_steps/checkout_develop_branch.rst
.. include:: release_steps/review_release_notes.rst
.. include:: release_steps/review_release_notes.rst
26 changes: 26 additions & 0 deletions docs/Release_Guide/release_steps/met/update_version.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Update Version Number for Release
---------------------------------

To update the MET version number, start by writing a GitHub issue to describe the change. Next, create a feature branch from the corresponding *main* branch (e.g. main_vX.Y).

- Details for an official release (e.g. vX.Y)
- Update the *met_version* variable in *met/src/basic/vx_util/util_constants.h* which defines the version number written to the MET output files.
- Update the *version* variable in *met/docs/conf.py* which defines the version number for the documentation.
- Update the version number in the locations listed above.
- Update the version number listed in the MET configuration files:
- Default configuration files in *met/data/config*.
- Sample configuration files in *met/scripts/config*.
- Test configuration files, searching recursively, in *test/config*.
- Add a new *met/data/table_files/met_header_columns_VX.Y.txt* defining the columns names for this version.
- Add a new *test/hdr/met_X_Y.hdr* file defining the column names for this version for the test scripts.

- Details for a bugfix release (e.g. vX.Y.Z)
- Update the *met_version* variable in *met/src/basic/vx_util/util_constants.h* which defines the version number written to the MET output files.
- Update the *version* variable in *met/docs/conf.py* defines the version number for the documentation.
- Do *NOT* update the version number in the configuration files, add a new table file, or add a new test header file.

- Details for a development release (e.g. vX.Y-betaN or vX.Y-rcN)
- Prior to creating the first development release (e.g. beta1) for a new version, the official release version number should have already been updated.
- If the official release version has not yet been updated (e.g. beta1), follow the official release instructions to do so.
- If the official release version has already been updated (e.g. beta2 and beyond), do the following:
- Update the *version* variable in *met/docs/conf.py* which defines the version number for the documentation.

0 comments on commit 303b35a

Please sign in to comment.