dtcenter · georgemccabe · Dec 3, 2020 · Oct 27, 2020 · Oct 29, 2020 · Oct 29, 2020
diff --git a/docs/Release_Guide/index.rst b/docs/Release_Guide/index.rst
@@ -0,0 +1,34 @@
+
+
+=============
+Release Guide
+=============
+
+
+The introduction can be put on this index.rst page, otherwise there won't be
+much content on this page.
+
+This document will describe the process for creating a METplus release and
+consist of up to seven chapters:
+
+
+.. toctree::
+   :titlesonly:
+   :numbered: 4
+
+   metplus
+   met
+   metdatadb
+   metcalcpy
+   metplotpy
+   metviewer
+   metexpress
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/Release_Guide/met.rst b/docs/Release_Guide/met.rst
@@ -0,0 +1,27 @@
+***********
+MET Release
+***********
+
+.. |projectRepo| replace:: MET
+
+Official release (e.g. vX.Y)
+============================
+
+Bugfix release (e.g. vX.Y.Z)
+============================
+
+.. include:: release_steps/open_release_issue.rst
+.. include:: release_steps/clone_project_repository.rst
+.. include:: release_steps/checkout_main_branch.rst
+.. include:: release_steps/met/update_bugfix_version.rst
+.. include:: release_steps/update_release_notes.rst
+.. include:: release_steps/merge_release_issue.rst
+.. include:: release_steps/create_release_on_github.rst
+.. include:: release_steps/met/build_release_tarfile.rst
+.. include:: release_steps/update_dtc_website.rst
+.. include:: release_steps/close_release_issue.rst
+.. include:: release_steps/met/update_docs.rst
+
+Development release (e.g. vX.Y-betaN or vX.Y-rcN)
+=================================================
+
diff --git a/docs/Release_Guide/metcalcpy.rst b/docs/Release_Guide/metcalcpy.rst
@@ -0,0 +1,20 @@
+*****************
+METcalcpy Release
+*****************
+
+.. |projectRepo| replace:: METcalcpy
+
+Official release (e.g. vX.Y)
+============================
+
+.. include:: release_steps/clone_project_repository.rst
+
+Bugfix release (e.g. vX.Y.Z)
+============================
+
+.. include:: release_steps/clone_project_repository.rst
+
+Development release (e.g. vX.Y-betaN or vX.Y-rcN)
+=================================================
+
+.. include:: release_steps/clone_project_repository.rst
diff --git a/docs/Release_Guide/metdatadb.rst b/docs/Release_Guide/metdatadb.rst
@@ -0,0 +1,21 @@
+*****************
+METdatadb Release
+*****************
+
+.. |projectRepo| replace:: METdatadb
+
+Official release (e.g. vX.Y)
+============================
+
+.. include:: release_steps/clone_project_repository.rst
+
+Bugfix release (e.g. vX.Y.Z)
+============================
+
+.. include:: release_steps/clone_project_repository.rst
+
+Development release (e.g. vX.Y-betaN or vX.Y-rcN)
+=================================================
+
+.. include:: release_steps/clone_project_repository.rst
+
diff --git a/docs/Release_Guide/metexpress.rst b/docs/Release_Guide/metexpress.rst
@@ -0,0 +1,20 @@
+******************
+METexpress Release
+******************
+
+.. |projectRepo| replace:: METexpress
+
+Official release (e.g. vX.Y)
+============================
+
+.. include:: release_steps/clone_project_repository.rst
+
+Bugfix release (e.g. vX.Y.Z)
+============================
+
+.. include:: release_steps/clone_project_repository.rst
+
+Development release (e.g. vX.Y-betaN or vX.Y-rcN)
+=================================================
+
+.. include:: release_steps/clone_project_repository.rst
diff --git a/docs/Release_Guide/metplotpy.rst b/docs/Release_Guide/metplotpy.rst
@@ -0,0 +1,20 @@
+******************
+METploypy Release
+******************
+
+.. |projectRepo| replace:: METploypy
+
+Official release (e.g. vX.Y)
+============================
+
+.. include:: release_steps/clone_project_repository.rst
+
+Bugfix release (e.g. vX.Y.Z)
+============================
+
+.. include:: release_steps/clone_project_repository.rst
+
+Development release (e.g. vX.Y-betaN or vX.Y-rcN)
+=================================================
+
+.. include:: release_steps/clone_project_repository.rst
diff --git a/docs/Release_Guide/metplus.rst b/docs/Release_Guide/metplus.rst
@@ -0,0 +1,47 @@
+***************
+METplus Release
+***************
+
+.. |projectRepo| replace:: METplus
+
+Official release (e.g. vX.Y.0)
+==============================
+
+.. include:: release_steps/clone_project_repository.rst
+.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/metplus/update_version_official.rst
+.. include:: release_steps/review_release_notes.rst
+.. include:: release_steps/metplus/update_docs_tagged.rst
+.. include:: release_steps/metplus/update_docker_build_hook.rst
+.. include:: release_steps/create_release_branch.rst
+.. include:: release_steps/metplus/update_readme.rst
+.. include:: release_steps/push_release_branch.rst
+.. include:: release_steps/create_release_on_github.rst
+.. include:: release_steps/metplus/create_release_extra.rst
+.. include:: release_steps/change_default_branch.rst
+.. include:: release_steps/metplus/update_version_on_develop.rst
+
+Bugfix release (e.g. vX.Y.Z)
+============================
+
+.. include:: release_steps/clone_project_repository.rst
+.. include:: release_steps/checkout_main_branch.rst
+.. include:: release_steps/metplus/update_version.rst
+.. 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.Z-betaN or vX.Y.Z-rcN)
+=====================================================
+
+.. include:: release_steps/clone_project_repository.rst
+.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/metplus/update_version.rst
+.. include:: release_steps/update_release_notes.rst
+.. include:: release_steps/metplus/update_docs_develop.rst
+.. include:: release_steps/metplus/update_docker_build_hook.rst
+.. include:: release_steps/create_release_branch.rst
+.. include:: release_steps/push_release_branch.rst
+.. include:: release_steps/create_release_on_github.rst
+.. include:: release_steps/metplus/create_release_extra.rst
+.. include:: release_steps/metplus/update_version_on_develop.rst
diff --git a/docs/Release_Guide/metviewer.rst b/docs/Release_Guide/metviewer.rst
@@ -0,0 +1,20 @@
+*****************
+METviewer Release
+*****************
+
+.. |projectRepo| replace:: METviewer
+
+Official release (e.g. vX.Y)
+============================
+
+.. include:: release_steps/clone_project_repository.rst
+
+Bugfix release (e.g. vX.Y.Z)
+============================
+
+.. include:: release_steps/clone_project_repository.rst
+
+Development release (e.g. vX.Y-betaN or vX.Y-rcN)
+=================================================
+
+.. include:: release_steps/clone_project_repository.rst
diff --git a/docs/Release_Guide/release_steps/change_default_branch.rst b/docs/Release_Guide/release_steps/change_default_branch.rst
@@ -0,0 +1,11 @@
+Change Default Branch on GitHub
+-------------------------------
+
+Change the default branch to the new main_vX.Y branch:
+
+.. parsed-literal::
+
+    https://github.com/dtcenter|projectRepo|
+    -> Settings
+    -> Branches (tab on left)
+    -> change the drop down to new branch
diff --git a/docs/Release_Guide/release_steps/checkout_develop_branch.rst b/docs/Release_Guide/release_steps/checkout_develop_branch.rst
@@ -0,0 +1,8 @@
+Checkout the Develop Branch
+---------------------------
+
+Checkout the develop branch
+
+.. parsed-literal::
+
+    git checkout develop
diff --git a/docs/Release_Guide/release_steps/checkout_main_branch.rst b/docs/Release_Guide/release_steps/checkout_main_branch.rst
@@ -0,0 +1,11 @@
+Checkout the Main Branch
+------------------------
+
+Checkout the main branch for the X.Y release. For example if you are creating
+the |projectRepo|-3.1.1 bugfix release, checkout main_v3.1.
+
+Example:
+
+.. parsed-literal::
+
+    git checkout main_v3.1
diff --git a/docs/Release_Guide/release_steps/clone_project_repository.rst b/docs/Release_Guide/release_steps/clone_project_repository.rst
@@ -0,0 +1,37 @@
+
+
+Clone the Project Repository
+----------------------------
+
+Create a fresh working directory
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Make a new directory to work in to ensure a fresh environment:
+
+.. parsed-literal::
+
+    mkdir release-X.Y.Z
+    cd release-X.Y.Z
+
+Clone the project repository
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Run the clone command to obtain the repository.
+
+Using SSH:
+
+.. parsed-literal::
+
+    git clone [email protected]:dtcenter/|projectRepo|
+
+Using HTTP:
+
+.. parsed-literal::
+
+    git clone https://github.com/dtcenter/|projectRepo|
+
+Enter the project repository directory
+
+.. parsed-literal::
+
+    cd |projectRepo|
diff --git a/docs/Release_Guide/release_steps/close_release_issue.rst b/docs/Release_Guide/release_steps/close_release_issue.rst
@@ -0,0 +1,8 @@
+Close Release Issue
+-------------------
+
+- Close the GitHub issue for creating this release.
+- If necessary, create a new milestone for the next release (e.g. next vX.Y.Z (bugfix) release).
+- If necessary, reassign any existing issues from the current to the next release.
+- Edit the milestone for the current release by updating the *Due date* with the current date.
+- Close the current milestone.
diff --git a/docs/Release_Guide/release_steps/create_release_branch.rst b/docs/Release_Guide/release_steps/create_release_branch.rst
@@ -0,0 +1,13 @@
+Create Release Branch
+---------------------
+
+Create a branch from the develop branch that corresponds to the release and
+push the branch to GitHub. For release X.Y-betaN, run the following commands
+(for bash, use setenv for first command if using csh)::
+
+    release_branch=main_vX.Y-betaN
+
+    cd METplus
+    git checkout develop
+    git pull
+    git checkout -b $release_branch
diff --git a/docs/Release_Guide/release_steps/create_release_on_github.rst b/docs/Release_Guide/release_steps/create_release_on_github.rst
@@ -0,0 +1,9 @@
+Create Release on GitHub
+------------------------
+
+- Go to Releases on GitHub and click 'Draft a new release'
+- Set tag based on version starting with 'v', i.e. vX.Y.Z, vX.Y.Z-betaN or v.X.Y.Z
+- Set branch value to main_vX.Y
+- Choose release name (i.e. |projectRepo|-X.Y.Z, |projectRepo|-X.Y.Z-betaN or |projectRepo|-X.Y.Z)
+- Add release notes from User's Guide to notes section
+- (Skip unless PDF of User's Guide is ready) Attach User's Guide PDF
diff --git a/docs/Release_Guide/release_steps/merge_release_issue.rst b/docs/Release_Guide/release_steps/merge_release_issue.rst
@@ -0,0 +1,4 @@
+Merge Release Issue
+-------------------
+
+After updating the version number and release notes on a feature branch, submit a pull request to merge those changes back into the source branch.
diff --git a/docs/Release_Guide/release_steps/met/build_release_tarfile.rst b/docs/Release_Guide/release_steps/met/build_release_tarfile.rst
@@ -0,0 +1,11 @@
+Build Release Tarfile
+---------------------
+
+The MET software is distributed as a tarfile, but not the one created by GitHub. On a project machine (e.g. kiowa), clone the MET repository and run a script to build the tarfile for the newly tagged release.
+
+.. parsed-literal::
+
+    git clone https://github.com/dtcenter/MET
+    met/scripts/met_checkout_and_build.sh tag vX.Y.Z
+
+Edit the vX.Y.Z release on GitHub by uploading the resulting tar file (met-X.Y.Z.YYYYMMDD.tar.gz) as a release asset.
diff --git a/docs/Release_Guide/release_steps/met/update_bugfix_version.rst b/docs/Release_Guide/release_steps/met/update_bugfix_version.rst
@@ -0,0 +1,7 @@
+Update Bugfix Release Version Number
+------------------------------------
+
+- Create and work on a feature branch from the corresponding *main* branch (e.g. main_vX.Y) being sure to include the GitHub issue number for the new release (e.g. feature_NNNN_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*, *release_year*, and *release_date* variables in *met/docs/conf.py* which 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.
diff --git a/docs/Release_Guide/release_steps/met/update_development_version.rst b/docs/Release_Guide/release_steps/met/update_development_version.rst
@@ -0,0 +1,8 @@
+Update Development Release Version Number
+-----------------------------------------
+
+- Work on a feature branch from the *develop* branch being sure to include the GitHub issue number for the new release (e.g. feature_NNNN_vX.Y.Z-betaN or feature_NNNN_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*, *release_year*, and *release_date* variables in *met/docs/conf.py* which defines the version number for the documentation.
diff --git a/docs/Release_Guide/release_steps/met/update_docs.rst b/docs/Release_Guide/release_steps/met/update_docs.rst
@@ -0,0 +1,17 @@
+Update the Documentation on the Web
+-----------------------------------
+
+- Regenerate the User's Guide and push the release to the gh-pages branch.
+- For example, on kiowa:
+
+.. parsed-literal::
+
+    git clone https://github.com/dtcenter/MET
+    cd MET/met/docs
+    git checkout vX.Y.Z
+    bash
+    conda deactivate
+    conda activate /home/met_test/.conda/envs/sphinx_env
+    make html
+
+- Store resulting html output files in the correct sub-directory on the gh-pages branch.
diff --git a/docs/Release_Guide/release_steps/met/update_official_version.rst b/docs/Release_Guide/release_steps/met/update_official_version.rst
@@ -0,0 +1,13 @@
+Update Official Release Version Number
+--------------------------------------
+
+- Create and work on a feature branch from the *develop* branch being sure to include the GitHub issue number for the new release (e.g. feature_NNNN_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*, *release_year*, and *release_date* variables 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.
diff --git a/docs/Release_Guide/release_steps/metplus/create_release_extra.rst b/docs/Release_Guide/release_steps/metplus/create_release_extra.rst
@@ -0,0 +1,3 @@
+- Add link to dtcenter.ucar.edu/dfiles/code/METplus/METplus_Data and add a note to
+  instruct users to use sub-directory corresponding to this release, i.e. v4.0.0)
+