Feature 673 metviewer release (#910)

Co-authored-by: jprestop <jpresto@ucar.edu> Co-authored-by: bikegeek <minnawin@ucar.edu>
dtcenter · May 10, 2021 · cabcee6 · cabcee6
1 parent a38fca5
commit cabcee6
Show file tree

Hide file tree

Showing 9 changed files with 92 additions and 2 deletions.
diff --git a/docs/Release_Guide/metviewer_bugfix.rst b/docs/Release_Guide/metviewer_bugfix.rst
@@ -7,5 +7,13 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch.
 
 .. include:: release_steps/open_release_issue.rst	     
 .. include:: release_steps/clone_project_repository.rst
-.. include:: release_steps/checkout_develop_branch.rst
+.. include:: release_steps/checkout_main_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
+.. include:: release_steps/metviewer/update_version_bugfix.rst
+.. include:: release_steps/update_release_notes_bugfix.rst
+.. include:: release_steps/merge_release_issue.rst
+.. include:: release_steps/create_release_on_github.rst
+.. include:: release_steps/metviewer/create_release_extra.rst
+.. include:: release_steps/metviewer/update_dtc_website.rst
+.. include:: release_steps/finalize_release_on_github_official.rst
+
diff --git a/docs/Release_Guide/metviewer_development.rst b/docs/Release_Guide/metviewer_development.rst
@@ -7,5 +7,13 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra
 
 .. include:: release_steps/open_release_issue.rst
 .. include:: release_steps/clone_project_repository.rst
-.. include:: release_steps/checkout_main_branch.rst
+.. include:: release_steps/checkout_develop_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
+.. include:: release_steps/metviewer/update_version.rst
+.. include:: release_steps/update_release_notes_development.rst
+.. include:: release_steps/merge_release_issue.rst
+.. include:: release_steps/create_release_on_github.rst
+.. include:: release_steps/metviewer/create_release_extra.rst
+.. include:: release_steps/metviewer/update_dtc_website.rst
+.. include:: release_steps/finalize_release_on_github_development.rst
+.. include:: release_steps/metviewer/update_version_on_develop.rst
diff --git a/docs/Release_Guide/metviewer_official.rst b/docs/Release_Guide/metviewer_official.rst
@@ -9,3 +9,16 @@ Create a new vX.Y.Z official release from the develop branch.
 .. include:: release_steps/clone_project_repository.rst
 .. include:: release_steps/checkout_develop_branch.rst
 .. include:: release_steps/create_release_feature_branch.rst
+.. include:: release_steps/metviewer/update_version_official.rst
+.. include:: release_steps/update_release_notes_official.rst
+.. include:: release_steps/rotate_authorship.rst
+.. include:: release_steps/merge_release_issue.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/metviewer/create_release_extra.rst
+.. include:: release_steps/metviewer/update_dtc_website.rst
+.. include:: release_steps/finalize_release_on_github_official.rst
+.. include:: release_steps/metviewer/update_version_on_develop.rst
+.. include:: release_steps/update_docs_official.rst
+
diff --git a/docs/Release_Guide/release_steps/metviewer/create_release_extra.rst b/docs/Release_Guide/release_steps/metviewer/create_release_extra.rst
@@ -0,0 +1,3 @@
+* If this is a development release, check the box that says "This is a pre-release"
+
+* Click on "Publish release".
diff --git a/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst b/docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst
@@ -0,0 +1,5 @@
+.. include:: release_steps/common/update_dtc_website.rst
+
+.. |projectName| replace:: |projectRepo|
+
+.. |addTarfileStep| replace:: Link text should be the name of the release and the URL should be the release page that was just created under the GitHub Releases tab.
diff --git a/docs/Release_Guide/release_steps/metviewer/update_version.rst b/docs/Release_Guide/release_steps/metviewer/update_version.rst
@@ -0,0 +1,10 @@
+Update Version Number for Release
+---------------------------------
+
+Create the version number
+
+- In the METviewer/docs/version file, assign the version to the '__version__' keyword
+- In the METviewer/build.xml file, assign the version in the 'dist' target
+- In the METviewer/vebapp/metviewer/metviewer1.jsp file, assign the version to <div id='release'> and <title>
+- We are naming releases with X.Y.Z format even if Z is 0.
+- In the develop branch, the version should match the upcoming release like X.Y.Z-betaN
diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst b/docs/Release_Guide/release_steps/metviewer/update_version_bugfix.rst
@@ -0,0 +1,12 @@
+Update Version Number for Release
+---------------------------------
+
+Update the version number for the bugfix release:
+
+* For METviewer, the file containing the version number is located at docs/version.
+* If the current release is listed as X.Y.Z (major.minor.micro), the bugfix version should be X.Y.Z+1
+  (i.e. increment the micro value by 1: 1.1.0 becomes 1.1.1)
+* In the METviewer/build.xml file, assign the version in the 'dist' target
+* In the METviewer/vebapp/metviewer/metviewer1.jsp file, assign the version to <div id='release'> and <title>
+
+
diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_official.rst b/docs/Release_Guide/release_steps/metviewer/update_version_official.rst
@@ -0,0 +1,11 @@
+Update Version Number for Release
+---------------------------------
+
+Remove **-dev** from the version number:
+
+* We are naming releases with X.Y.Z format even if Z is 0.
+* The file containing the version number is located at docs/version.
+* In the METviewer/build.xml file, assign the version in the 'dist' target
+* In the METviewer/vebapp/metviewer/metviewer1.jsp file, assign the version to <div id='release'> and <title>
+
+* Save and close the file.
diff --git a/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst b/docs/Release_Guide/release_steps/metviewer/update_version_on_develop.rst
@@ -0,0 +1,20 @@
+Update Version on Develop Branch
+--------------------------------
+
+Change METviewer/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.Y.Z-dev          |
++-------------------+-----------------------+
+|    X.Y.Z          |   (X+1).0.0-beta1-dev |
++-------------------+-----------------------+
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		* If this is a development release, check the box that says "This is a pre-release"

		* Click on "Publish release".