Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature 673 metviewer release #910

Merged
merged 25 commits into from
May 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
c3214d4
GitHub Issue #673 METviewer release guide "stubs". Details pertainin…
bikegeek Mar 10, 2021
755536c
change METplotpy to METviewer and added extra steps #673
TatianaBurek Apr 27, 2021
f79112e
change METplotpy to METviewer #673
TatianaBurek Apr 27, 2021
3c6a31d
remove unused update_dtc_website step #673
TatianaBurek Apr 27, 2021
64e70ec
Copy of instructions for updating the DTC website.
bikegeek Apr 29, 2021
b24e4c4
Added step to update DTC website
bikegeek Apr 29, 2021
c59544c
resolved conflicts
bikegeek Apr 30, 2021
b58dc60
updated bugfix and official METviewer docs #673
TatianaBurek May 4, 2021
16c3005
Merge branch 'feature_673_METviewer_release' of https://github.com/dt…
TatianaBurek May 4, 2021
ec2e6f0
deleted based on Julie's suggestion: it is no longer necessary to a m…
TatianaBurek May 7, 2021
d393cb4
Update docs/Release_Guide/release_steps/metviewer/update_dtc_website.rst
TatianaBurek May 7, 2021
4390ed5
quicksearch.rst is removed as there is no docs/Users_Guide/quicksear…
TatianaBurek May 7, 2021
9feee54
quicksearch.rst is removed as there is no docs/Users_Guide/quicksear…
TatianaBurek May 7, 2021
74c8308
quicksearch.rst is removed as there is no docs/Users_Guide/quicksear…
TatianaBurek May 7, 2021
b85b0c3
update_docs_develop.rst is removed because we have moved to ReadtheDo…
TatianaBurek May 7, 2021
e2cfb83
update_docs_tagged.rst is removed because we have moved to ReadtheDoc…
TatianaBurek May 7, 2021
e5f3726
added create_release_feature_branch.rst #673
TatianaBurek May 7, 2021
19f792d
added create_release_feature_branch.rst #673
TatianaBurek May 7, 2021
04b32cf
added create_release_feature_branch.rst #673
TatianaBurek May 7, 2021
d568e44
moved create_release_extra.rst and deleted update_dtc_website.rst #673
TatianaBurek May 7, 2021
642b7c7
added update_docs_official.rst #673
TatianaBurek May 7, 2021
309b237
Merge remote-tracking branch 'origin/feature_673_METviewer_release' i…
TatianaBurek May 7, 2021
fe34506
Added update_dtc_website.rst to metviewer_bugfix.rst and metviewer_of…
jprestop May 7, 2021
e093938
Added rotate_authorship.rst to met_viewer_official.rst
jprestop May 7, 2021
7276159
Added .. include:: release_steps/metviewer/update_dtc_website.rst
jprestop May 7, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/Release_Guide/metviewer_bugfix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

10 changes: 9 additions & 1 deletion docs/Release_Guide/metviewer_development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
13 changes: 13 additions & 0 deletions docs/Release_Guide/metviewer_official.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

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".
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 10 additions & 0 deletions docs/Release_Guide/release_steps/metviewer/update_version.rst
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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>


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