From f13a7d8255c2272ed4f21c90a753e1e4bbd5b350 Mon Sep 17 00:00:00 2001 From: Venita Hagerty Date: Thu, 13 May 2021 15:36:46 -0600 Subject: [PATCH] Added more content to METdatadb release guides, following model of METcalcpy --- docs/Release_Guide/metdatadb_bugfix.rst | 9 +++++++++ docs/Release_Guide/metdatadb_development.rst | 10 ++++++++++ docs/Release_Guide/metdatadb_official.rst | 14 +++++++++++++ .../metdatadb/create_release_extra.rst | 3 +++ .../metdatadb/update_version.rst | 12 +++++++++++ .../metdatadb/update_version_bugfix.rst | 8 ++++++++ .../metdatadb/update_version_official.rst | 9 +++++++++ .../metdatadb/update_version_on_develop.rst | 20 +++++++++++++++++++ 8 files changed, 85 insertions(+) create mode 100644 docs/Release_Guide/release_steps/metdatadb/create_release_extra.rst create mode 100644 docs/Release_Guide/release_steps/metdatadb/update_version.rst create mode 100644 docs/Release_Guide/release_steps/metdatadb/update_version_bugfix.rst create mode 100644 docs/Release_Guide/release_steps/metdatadb/update_version_official.rst create mode 100644 docs/Release_Guide/release_steps/metdatadb/update_version_on_develop.rst diff --git a/docs/Release_Guide/metdatadb_bugfix.rst b/docs/Release_Guide/metdatadb_bugfix.rst index 93e60ac5d7..aa472354ed 100644 --- a/docs/Release_Guide/metdatadb_bugfix.rst +++ b/docs/Release_Guide/metdatadb_bugfix.rst @@ -2,6 +2,8 @@ METdatadb Bugfix Release ======================== .. |projectRepo| replace:: METdatadb +.. |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. Create a new vX.Y.Z bugfix release from the main_vX.Y branch. @@ -9,3 +11,10 @@ Create a new vX.Y.Z bugfix release from the main_vX.Y branch. .. include:: release_steps/clone_project_repository.rst .. include:: release_steps/checkout_main_branch.rst .. include:: release_steps/create_release_feature_branch.rst +.. include:: release_steps/metdatadb/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/metdatadb/create_release_extra.rst +.. include:: release_steps/common/update_dtc_website.rst +.. include:: release_steps/finalize_release_on_github_bugfix.rst diff --git a/docs/Release_Guide/metdatadb_development.rst b/docs/Release_Guide/metdatadb_development.rst index 8303c3baa1..ecdfa57863 100644 --- a/docs/Release_Guide/metdatadb_development.rst +++ b/docs/Release_Guide/metdatadb_development.rst @@ -2,6 +2,8 @@ METdatadb Development Release ============================= .. |projectRepo| replace:: METdatadb +.. |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. Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop branch while working toward an official vX.Y.Z release. @@ -9,3 +11,11 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. 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/metdatadb/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/metdatadb/create_release_extra.rst +.. include:: release_steps/common/update_dtc_website.rst +.. include:: release_steps/finalize_release_on_github_development.rst +.. include:: release_steps/metdatadb/update_version_on_develop.rst \ No newline at end of file diff --git a/docs/Release_Guide/metdatadb_official.rst b/docs/Release_Guide/metdatadb_official.rst index 230d4abc42..86aa2e8c27 100644 --- a/docs/Release_Guide/metdatadb_official.rst +++ b/docs/Release_Guide/metdatadb_official.rst @@ -2,6 +2,8 @@ METdatadb Official Release ========================== .. |projectRepo| replace:: METdatadb +.. |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. Create a new vX.Y.Z official release from the develop branch. @@ -9,3 +11,15 @@ 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/metdatadb/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/metdatadb/create_release_extra.rst +.. include:: release_steps/common/update_dtc_website.rst +.. include:: release_steps/finalize_release_on_github_official.rst +.. include:: release_steps/metdatadb/update_version_on_develop.rst +.. include:: release_steps/update_docs_official.rst diff --git a/docs/Release_Guide/release_steps/metdatadb/create_release_extra.rst b/docs/Release_Guide/release_steps/metdatadb/create_release_extra.rst new file mode 100644 index 0000000000..fa062c099b --- /dev/null +++ b/docs/Release_Guide/release_steps/metdatadb/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". \ No newline at end of file diff --git a/docs/Release_Guide/release_steps/metdatadb/update_version.rst b/docs/Release_Guide/release_steps/metdatadb/update_version.rst new file mode 100644 index 0000000000..55ab9b89d6 --- /dev/null +++ b/docs/Release_Guide/release_steps/metdatadb/update_version.rst @@ -0,0 +1,12 @@ +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 develop branch, the version should match the upcoming release with -dev added to the end like X.Y.Z-betaN-dev, i.e. 4.0.0-beta1-dev + +* Remove **-dev** from the version number so that it matches the release you are creating. + +* Commit changes and push to GitHub. \ No newline at end of file diff --git a/docs/Release_Guide/release_steps/metdatadb/update_version_bugfix.rst b/docs/Release_Guide/release_steps/metdatadb/update_version_bugfix.rst new file mode 100644 index 0000000000..8b3c78f6c6 --- /dev/null +++ b/docs/Release_Guide/release_steps/metdatadb/update_version_bugfix.rst @@ -0,0 +1,8 @@ +Update Version Number for Release +--------------------------------- + +Update the version number for the bugfix release: + +* For |projectRepo|, 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) \ No newline at end of file diff --git a/docs/Release_Guide/release_steps/metdatadb/update_version_official.rst b/docs/Release_Guide/release_steps/metdatadb/update_version_official.rst new file mode 100644 index 0000000000..264019f839 --- /dev/null +++ b/docs/Release_Guide/release_steps/metdatadb/update_version_official.rst @@ -0,0 +1,9 @@ +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 develop branch, the version should match the upcoming release with -dev added to the end like X.Y.Z-betaN-dev, i.e. 4.0.0-beta1-dev +* Remove **-dev** from the version number so that it matches the release you are creating. diff --git a/docs/Release_Guide/release_steps/metdatadb/update_version_on_develop.rst b/docs/Release_Guide/release_steps/metdatadb/update_version_on_develop.rst new file mode 100644 index 0000000000..0822719c00 --- /dev/null +++ b/docs/Release_Guide/release_steps/metdatadb/update_version_on_develop.rst @@ -0,0 +1,20 @@ +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: + ++-------------------+-----------------------+ +| 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 | ++-------------------+-----------------------+ \ No newline at end of file