From 63d88d41b8996dfb09b39a1ee2a96391ece8a20f Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Fri, 15 Sep 2023 14:50:14 -0600 Subject: [PATCH 1/5] Per #2156, refine instructions --- docs/Release_Guide/coordinated.rst | 1 + docs/Release_Guide/met_development.rst | 1 + docs/Release_Guide/metcalcpy_development.rst | 1 + docs/Release_Guide/metdataio_development.rst | 1 + docs/Release_Guide/metexpress_development.rst | 1 + docs/Release_Guide/metplotpy_development.rst | 1 + docs/Release_Guide/metplus_development.rst | 1 + docs/Release_Guide/metplus_official.rst | 2 +- docs/Release_Guide/metviewer_development.rst | 1 + .../release_acceptance_testing.rst | 16 ++++++ .../release_acceptance_testing.rst | 52 +++++++++++++++++++ 11 files changed, 77 insertions(+), 1 deletion(-) create mode 100644 docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst create mode 100644 docs/Release_Guide/release_steps/release_acceptance_testing.rst diff --git a/docs/Release_Guide/coordinated.rst b/docs/Release_Guide/coordinated.rst index 4abd404a1..27e567c75 100644 --- a/docs/Release_Guide/coordinated.rst +++ b/docs/Release_Guide/coordinated.rst @@ -19,5 +19,6 @@ component releases. .. include:: release_steps/coordinated/update_dtc_website.rst .. include:: release_steps/coordinated/finalize_release_on_github.rst +.. include:: release_steps/coordinated/release_acceptance_testing.rst .. include:: release_steps/coordinated/update_zenodo.rst .. include:: release_steps/coordinated/announce_release.rst diff --git a/docs/Release_Guide/met_development.rst b/docs/Release_Guide/met_development.rst index 3690a9468..2613dbbd5 100644 --- a/docs/Release_Guide/met_development.rst +++ b/docs/Release_Guide/met_development.rst @@ -17,3 +17,4 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/create_release_extra.rst .. include:: release_steps/met/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_development.rst +.. include:: release_steps/release_acceptance_testing.rst diff --git a/docs/Release_Guide/metcalcpy_development.rst b/docs/Release_Guide/metcalcpy_development.rst index 936a9c9ce..4d631047d 100644 --- a/docs/Release_Guide/metcalcpy_development.rst +++ b/docs/Release_Guide/metcalcpy_development.rst @@ -17,4 +17,5 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/create_release_extra.rst .. include:: release_steps/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_development.rst +.. include:: release_steps/release_acceptance_testing.rst .. include:: release_steps/metcalcpy/update_version_on_develop.rst diff --git a/docs/Release_Guide/metdataio_development.rst b/docs/Release_Guide/metdataio_development.rst index 810725ccf..8789d1c36 100644 --- a/docs/Release_Guide/metdataio_development.rst +++ b/docs/Release_Guide/metdataio_development.rst @@ -20,4 +20,5 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/create_release_extra.rst .. include:: release_steps/common/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_development.rst +.. include:: release_steps/release_acceptance_testing.rst .. include:: release_steps/metdataio/update_version_on_develop.rst diff --git a/docs/Release_Guide/metexpress_development.rst b/docs/Release_Guide/metexpress_development.rst index 84a355114..31b1d972a 100644 --- a/docs/Release_Guide/metexpress_development.rst +++ b/docs/Release_Guide/metexpress_development.rst @@ -11,3 +11,4 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/metexpress/merge_feature_branch.rst .. include:: release_steps/metexpress/update_dtc_website.rst .. include:: release_steps/metexpress/finalize_release_on_github_development.rst +.. include:: release_steps/release_acceptance_testing.rst diff --git a/docs/Release_Guide/metplotpy_development.rst b/docs/Release_Guide/metplotpy_development.rst index 3e78b5c84..a08ac7e6a 100644 --- a/docs/Release_Guide/metplotpy_development.rst +++ b/docs/Release_Guide/metplotpy_development.rst @@ -17,6 +17,7 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/create_release_extra.rst .. include:: release_steps/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_development.rst +.. include:: release_steps/release_acceptance_testing.rst .. include:: release_steps/metplotpy/update_version_on_develop.rst diff --git a/docs/Release_Guide/metplus_development.rst b/docs/Release_Guide/metplus_development.rst index 6dd1b4b1f..b6d568e5b 100644 --- a/docs/Release_Guide/metplus_development.rst +++ b/docs/Release_Guide/metplus_development.rst @@ -18,3 +18,4 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/metplus/update_version_on_develop.rst .. include:: release_steps/metplus/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_development.rst +.. include:: release_steps/release_acceptance_testing.rst diff --git a/docs/Release_Guide/metplus_official.rst b/docs/Release_Guide/metplus_official.rst index a2d77cac9..a81edf37f 100644 --- a/docs/Release_Guide/metplus_official.rst +++ b/docs/Release_Guide/metplus_official.rst @@ -20,7 +20,7 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/create_release_on_github.rst .. include:: release_steps/metplus/create_release_extra.rst .. include:: release_steps/metplus/update_dtc_website.rst -.. include:: release_steps/finalize_release_on_github_official.rst +.. include:: release_steps/finalize_release_on_github_official.rst .. include:: release_steps/metplus/update_version_on_develop.rst .. include:: release_steps/update_docs_official.rst .. include:: release_steps/metplus/update_web_server_data.rst diff --git a/docs/Release_Guide/metviewer_development.rst b/docs/Release_Guide/metviewer_development.rst index 6b2cea9e8..239b92899 100644 --- a/docs/Release_Guide/metviewer_development.rst +++ b/docs/Release_Guide/metviewer_development.rst @@ -17,4 +17,5 @@ Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop bra .. include:: release_steps/create_release_extra.rst .. include:: release_steps/update_dtc_website.rst .. include:: release_steps/finalize_release_on_github_development.rst +.. include:: release_steps/release_acceptance_testing.rst .. include:: release_steps/metviewer/update_version_on_develop.rst diff --git a/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst b/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst new file mode 100644 index 000000000..626d3441c --- /dev/null +++ b/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst @@ -0,0 +1,16 @@ +Release Acceptance Testing +-------------------------- + +A single GitHub Discussion is created in the METplus repository in the +`Release Acceptance Testing `_ +category to summarize external testing for all development cycles of the METplus +components included in a coordinated release. + +* Navigate to the `Release Acceptance Testing `_ + discussion for this coordinated release. +* Review and finalize any entries still marked as **OPEN** or **FAIL** in the **Status** + column of the repository testing tables. Ideally, the status for all table entries + should be **PASS** for a coordinated release. +* Click on the **Close discussion** button at the bottom discussion. +* Do *not* **Lock conversation** on this discussion to allow external testers + to provide additional comments, as needed. diff --git a/docs/Release_Guide/release_steps/release_acceptance_testing.rst b/docs/Release_Guide/release_steps/release_acceptance_testing.rst new file mode 100644 index 000000000..4b327c838 --- /dev/null +++ b/docs/Release_Guide/release_steps/release_acceptance_testing.rst @@ -0,0 +1,52 @@ +Release Acceptance Testing +-------------------------- + +A single GitHub Discussion is created in the METplus repository in the +`Release Acceptance Testing `_ +category to summarize external testing for all development cycles of the METplus +components included in a coordinated release. + +* If creating a release for the first development cycle (e.g. beta1 release), + check to see if the + `Release Acceptance Testing `_ + discussion for the next coordinated release has already been created. +* If not, create a new one to summarize external testing for all development + cycles of the METplus components. + + * Locate the **Release Acceptance Testing** discussion for the last + coordinated release. + * Copy and paste its contents into a new discussion, being sure to update + the title of the discussion and empty the contents of repository testing + tables for each of the METplus components. + * Carefully review the contents and links and update them as needed. + * If needed, create a new label for the next **METplus X.Y Coordinated Release** + in the METplus repository and add that label to this discussion. + +* Update the contents of the **Release Acceptance Testing** discussion for + each |projectRepo| development release. + + * Locate the |projectRepo| repository testing table within the body of the discussion. + * For issues for which no external testing is required: + + * Create a *single table entry* for this development cycle. + * Set the "Status" column to **PASS**. + * Set the "|projectRepo| Issue" column to a list of links for all of the issues. + * Set the "Dev Cycle" column to the current development cycle name (e.g. beta1, beta2, beta3, rc1). + * Leave the "Tester" column empty. + * Set the "Acceptance Testing Comment Link" column to **No external testing required**. + + * For issues that do require external testing: + + * Create a *separate table entry* for each issue. + * Set the "Status" column to **OPEN**. + * Set the "|projectRepo| Issue" column to link to the issue. + * Set the "Dev Cycle" column to the current development cycle name (e.g. beta1, beta2, beta3, rc1). + * Set the "Tester" column to a list of GitHub user name(s) to solicit their feedback. + * Leave the "Acceptance Testing Comment Link" column empty. + + * Save your edits to the discussion. + +* External testers are instructed to add comments to the discussion to summarize + the status of their testing. The METplus team monitors those comments and, as needed, + updates the "Status" and "Acceptance Testing Comment Link" columns of the repository + testing table for each METplus component. From ee59df352222aaa4b3c751a1b4e692e3459836bf Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Mon, 18 Sep 2023 12:06:53 -0600 Subject: [PATCH 2/5] Per #2156, use dropdowns to make the instrutions more concise. --- .../release_acceptance_testing.rst | 25 ++--- .../release_acceptance_testing.rst | 98 ++++++++++--------- 2 files changed, 64 insertions(+), 59 deletions(-) diff --git a/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst b/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst index 626d3441c..ca3961287 100644 --- a/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst +++ b/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst @@ -1,16 +1,19 @@ Release Acceptance Testing -------------------------- -A single GitHub Discussion is created in the METplus repository in the +A single `Release Acceptance Testing `_ -category to summarize external testing for all development cycles of the METplus -components included in a coordinated release. +discussion in the METplus repository summarizes the external testing for all development +cycles of the METplus components included in a coordinated release. -* Navigate to the `Release Acceptance Testing `_ - discussion for this coordinated release. -* Review and finalize any entries still marked as **OPEN** or **FAIL** in the **Status** - column of the repository testing tables. Ideally, the status for all table entries - should be **PASS** for a coordinated release. -* Click on the **Close discussion** button at the bottom discussion. -* Do *not* **Lock conversation** on this discussion to allow external testers - to provide additional comments, as needed. +.. dropdown:: Instructions + + * Navigate to the + `Release Acceptance Testing `_ + discussion for this coordinated release. + * Review and finalize any entries still marked as **OPEN** or **FAIL** in the **Status** + column of the repository testing tables. Ideally, the status for all table entries + should be **PASS** for a coordinated release. + * Click on the **Close discussion** button at the bottom discussion. + * Do *not* **Lock conversation** on this discussion to allow external testers + to provide additional comments, as needed. diff --git a/docs/Release_Guide/release_steps/release_acceptance_testing.rst b/docs/Release_Guide/release_steps/release_acceptance_testing.rst index 4b327c838..a5cad0182 100644 --- a/docs/Release_Guide/release_steps/release_acceptance_testing.rst +++ b/docs/Release_Guide/release_steps/release_acceptance_testing.rst @@ -1,52 +1,54 @@ Release Acceptance Testing -------------------------- -A single GitHub Discussion is created in the METplus repository in the +A single `Release Acceptance Testing `_ -category to summarize external testing for all development cycles of the METplus -components included in a coordinated release. - -* If creating a release for the first development cycle (e.g. beta1 release), - check to see if the - `Release Acceptance Testing `_ - discussion for the next coordinated release has already been created. -* If not, create a new one to summarize external testing for all development - cycles of the METplus components. - - * Locate the **Release Acceptance Testing** discussion for the last - coordinated release. - * Copy and paste its contents into a new discussion, being sure to update - the title of the discussion and empty the contents of repository testing - tables for each of the METplus components. - * Carefully review the contents and links and update them as needed. - * If needed, create a new label for the next **METplus X.Y Coordinated Release** - in the METplus repository and add that label to this discussion. - -* Update the contents of the **Release Acceptance Testing** discussion for - each |projectRepo| development release. - - * Locate the |projectRepo| repository testing table within the body of the discussion. - * For issues for which no external testing is required: - - * Create a *single table entry* for this development cycle. - * Set the "Status" column to **PASS**. - * Set the "|projectRepo| Issue" column to a list of links for all of the issues. - * Set the "Dev Cycle" column to the current development cycle name (e.g. beta1, beta2, beta3, rc1). - * Leave the "Tester" column empty. - * Set the "Acceptance Testing Comment Link" column to **No external testing required**. - - * For issues that do require external testing: - - * Create a *separate table entry* for each issue. - * Set the "Status" column to **OPEN**. - * Set the "|projectRepo| Issue" column to link to the issue. - * Set the "Dev Cycle" column to the current development cycle name (e.g. beta1, beta2, beta3, rc1). - * Set the "Tester" column to a list of GitHub user name(s) to solicit their feedback. - * Leave the "Acceptance Testing Comment Link" column empty. - - * Save your edits to the discussion. - -* External testers are instructed to add comments to the discussion to summarize - the status of their testing. The METplus team monitors those comments and, as needed, - updates the "Status" and "Acceptance Testing Comment Link" columns of the repository - testing table for each METplus component. +discussion in the METplus repository summarizes the external testing for all development +cycles of the METplus components included in a coordinated release. + +.. dropdown:: Instructions + + * If creating a release for the first development cycle (e.g. beta1 release), + check to see if the + `Release Acceptance Testing `_ + discussion for the next coordinated release has already been created. + * If not, create a new one to summarize external testing for all development + cycles of the METplus components. + + * Locate the **Release Acceptance Testing** discussion for the last + coordinated release. + * Copy and paste its contents into a new discussion, being sure to update + the title of the discussion and empty the contents of repository testing + tables for each of the METplus components. + * Carefully review the contents and links and update them as needed. + * If needed, create a new label for the next **METplus X.Y Coordinated Release** + in the METplus repository and add that label to this discussion. + + * Update the contents of the **Release Acceptance Testing** discussion for + each |projectRepo| development release. + + * Locate the |projectRepo| repository testing table within the body of the discussion. + * For issues for which no external testing is required: + + * Create a *single table entry* for this development cycle. + * Set the "Status" column to **PASS**. + * Set the "|projectRepo| Issue" column to a list of links for all of the issues. + * Set the "Dev Cycle" column to the current development cycle name (e.g. beta1, beta2, beta3, rc1). + * Leave the "Tester" column empty. + * Set the "Acceptance Testing Comment Link" column to **No external testing required**. + + * For issues that do require external testing: + + * Create a *separate table entry* for each issue. + * Set the "Status" column to **OPEN**. + * Set the "|projectRepo| Issue" column to link to the issue. + * Set the "Dev Cycle" column to the current development cycle name (e.g. beta1, beta2, beta3, rc1). + * Set the "Tester" column to a list of GitHub user name(s) to solicit their feedback. + * Leave the "Acceptance Testing Comment Link" column empty. + + * Save your edits to the discussion. + + * External testers are instructed to add comments to the discussion to summarize + the status of their testing. The METplus team monitors those comments and, as needed, + updates the "Status" and "Acceptance Testing Comment Link" columns of the repository + testing table for each METplus component. From 8449f4c0ae15e3f00d32f70874dc08435b0dd69e Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Wed, 20 Sep 2023 13:00:20 -0600 Subject: [PATCH 3/5] Per #2156, tweak release acceptance testing wording and add dropdown for updating the DTC website. --- .../common/update_dtc_website.rst | 94 ++++++++++--------- .../release_acceptance_testing.rst | 6 +- .../coordinated/update_dtc_website.rst | 81 ++++++++-------- 3 files changed, 95 insertions(+), 86 deletions(-) diff --git a/docs/Release_Guide/release_steps/common/update_dtc_website.rst b/docs/Release_Guide/release_steps/common/update_dtc_website.rst index 7f8b1be69..ca7da0871 100644 --- a/docs/Release_Guide/release_steps/common/update_dtc_website.rst +++ b/docs/Release_Guide/release_steps/common/update_dtc_website.rst @@ -1,70 +1,74 @@ Update DTC Website ------------------ -* Navigate to https://dtcenter.org and sign in to the Drupal interface. +METplus software releases are announced on the `DTC website `_. +Add or update information about software releases on the website. -* Navigate to the downloads page for the |projectRepo| repository at - https://dtcenter.org/community-code/metplus/download +.. dropdown:: Instructions -* Click on the **Edit** button to edit the Downloads page. + * Navigate to https://dtcenter.org and sign in to the Drupal interface. -* Create a new **Software Release** for the newly released version by clicking - on **Add New Release**. + * Navigate to the downloads page for the |projectRepo| repository at + https://dtcenter.org/community-code/metplus/download - * For **Full Title of Release** type "|projectRepo| Version X.Y.Z". + * Click on the **Edit** button to edit the Downloads page. - * For **Related Community Code** select both the "METplus" and the "|projectName|" - options (For Macs, hold the Command key to select both). + * Create a new **Software Release** for the newly released version by clicking + on **Add New Release**. - * For **Version Label** type "|projectRepo| X.Y.Z-betaN". + * For **Full Title of Release** type "|projectRepo| Version X.Y.Z". - * Select the **Release Type** ("Recommended" for official or bugfix releases or - "Development" for development versions). + * For **Related Community Code** select both the "METplus" and the "|projectName|" + options (For Macs, hold the Command key to select both). - * Enter the **Release Date**. + * For **Version Label** type "|projectRepo| X.Y.Z-betaN". - * Click on **Add Code Download** then click **Add Link** to add links for each of the following: + * Select the **Release Type** ("Recommended" for official or bugfix releases or + "Development" for development versions). - * Add Link: |addTarfileStep| + * Enter the **Release Date**. - * Add Link: Link text should be "User's Guide" and the URL should be the top - level directory of the User's Guide hosted on the web. Beta releases can - use "develop" in the URL, but for official releases, please ensure the - link uses the branch name (e.g. main_vX.Y) as opposed to the tag name - (e.g. vX.Y.Z). For example, use - "https://metplus.readthedocs.io/en/main_vX.Y/Users_Guide/" and NOT - "https://metplus.readthedocs.io/en/vX.Y.Z/Users_Guide/" + * Click on **Add Code Download** then click **Add Link** to add links for each of the following: - * Add Link: Link text should be "Existing Builds and Docker" and the URL - should be the latest Existing Builds page, i.e. - https://dtcenter.org/community-code/metplus/metplus-X-Y-existing-builds - (If creating a new official release, be sure to add a new *Existing Builds - and Docker* page, if one was not already created.) + * Add Link: |addTarfileStep| + + * Add Link: Link text should be "User's Guide" and the URL should be the top + level directory of the User's Guide hosted on the web. Beta releases can + use "develop" in the URL, but for official releases, please ensure the + link uses the branch name (e.g. main_vX.Y) as opposed to the tag name + (e.g. vX.Y.Z). For example, use + "https://metplus.readthedocs.io/en/main_vX.Y/Users_Guide/" and NOT + "https://metplus.readthedocs.io/en/vX.Y.Z/Users_Guide/" + + * Add Link: Link text should be "Existing Builds and Docker" and the URL + should be the latest Existing Builds page, i.e. + https://dtcenter.org/community-code/metplus/metplus-X-Y-existing-builds + (If creating a new official release, be sure to add a new *Existing Builds + and Docker* page, if one was not already created.) - * In the **Release Notes** text box provide a direct link to the - *release-notes.html* file in the User's Guide. + * In the **Release Notes** text box provide a direct link to the + *release-notes.html* file in the User's Guide. - * Click on **Create Release**. + * Click on **Create Release**. - * Update the existing releases, as needed. + * Update the existing releases, as needed. - * For a development release, ensure the "Release Type" is set to - **Development** and change any previous **Development** versions to - **Other**. + * For a development release, ensure the "Release Type" is set to + **Development** and change any previous **Development** versions to + **Other**. - * For a bugfix or official release, change any previous - **Recommended** versions to **Other**. + * For a bugfix or official release, change any previous + **Recommended** versions to **Other**. - * For an official release, remove the corresponding development - releases. + * For an official release, remove the corresponding development + releases. - * Edit the "Coordinated METplus Version X.Y" software release. + * Edit the "Coordinated METplus Version X.Y" software release. - * For a bugfix release, update the existing link and text in - the "Coordinated METplus-X.Y" release section with the - X.Y.Z+1 information. - - * |otherWebsiteUpdates| + * For a bugfix release, update the existing link and text in + the "Coordinated METplus-X.Y" release section with the + X.Y.Z+1 information. - * Click on **Save** at the bottom of the page. + * |otherWebsiteUpdates| + * Click on **Save** at the bottom of the page. diff --git a/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst b/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst index ca3961287..8f290da7c 100644 --- a/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst +++ b/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst @@ -11,9 +11,9 @@ cycles of the METplus components included in a coordinated release. * Navigate to the `Release Acceptance Testing `_ discussion for this coordinated release. - * Review and finalize any entries still marked as **OPEN** or **FAIL** in the **Status** - column of the repository testing tables. Ideally, the status for all table entries - should be **PASS** for a coordinated release. + * Review the repository testing tables for the METplus components within the body of the discussion. + * Check the **Status** column in these tables and look for entries still marked as **OPEN** or **FAIL**. + For a coordinated release, the status for all table entries should be **PASS**. * Click on the **Close discussion** button at the bottom discussion. * Do *not* **Lock conversation** on this discussion to allow external testers to provide additional comments, as needed. diff --git a/docs/Release_Guide/release_steps/coordinated/update_dtc_website.rst b/docs/Release_Guide/release_steps/coordinated/update_dtc_website.rst index 6082e88ca..6674195c6 100644 --- a/docs/Release_Guide/release_steps/coordinated/update_dtc_website.rst +++ b/docs/Release_Guide/release_steps/coordinated/update_dtc_website.rst @@ -1,66 +1,71 @@ Update DTC Website ------------------ -* Navigate to https://dtcenter.org and sign in to the Drupal interface. +METplus software releases are announced on the `DTC website `_. +Add or update information about software releases on the website. -* Navigate to the METplus downloads page at - https://dtcenter.org/community-code/metplus/download +.. dropdown:: Instructions -* Click on the **Edit** button to edit the Downloads page. + * Navigate to https://dtcenter.org and sign in to the Drupal interface. -* Create a new **Software Release** for the new coordinated release by clicking - on **Add New Release**. + * Navigate to the METplus downloads page at + https://dtcenter.org/community-code/metplus/download - * For **Full Title of Release** type "Coorindated METplus X.Y". + * Click on the **Edit** button to edit the Downloads page. - * For **Related Community Code** select only the "METplus" option. + * Create a new **Software Release** for the new coordinated release by clicking + on **Add New Release**. - * For **Version Label** type "Coordinated METplus X.Y". + * For **Full Title of Release** type "Coorindated METplus X.Y". - * Select the **Release Type** as "Recommended". + * For **Related Community Code** select only the "METplus" option. - * Select the **Release Options** as "Coordinated". + * For **Version Label** type "Coordinated METplus X.Y". - * Enter the **Release Date**. + * Select the **Release Type** as "Recommended". - * Click on **Add Code Download** then click **Add Link** to add links for each of the following: + * Select the **Release Options** as "Coordinated". - * Add Link: Link text should be "METplus X.Y.Z" and the URL should be a link to the METplus component DTC release page. + * Enter the **Release Date**. - * Add Link: Link text should be "MET X.Y.Z" and the URL should be a link to the MET component DTC release page. + * Click on **Add Code Download** then click **Add Link** to add links for each of the following: - * Add Link: Link text should be "METviewer X.Y.Z" and the URL should be a link to the METviewer component DTC release page. + * Add Link: Link text should be "METplus X.Y.Z" and the URL should be a link to the METplus component DTC release page. - * Add Link: Link text should be "METexpress X.Y.Z" and the URL should be a link to the METexpress component DTC release page. + * Add Link: Link text should be "MET X.Y.Z" and the URL should be a link to the MET component DTC release page. - * Add Link: Link text should be "METplotpy X.Y.Z" and the URL should be a link to the METplotpy component DTC release page. + * Add Link: Link text should be "METviewer X.Y.Z" and the URL should be a link to the METviewer component DTC release page. - * Add Link: Link text should be "METcalcpy X.Y.Z" and the URL should be a link to the METcalcpy component DTC release page. + * Add Link: Link text should be "METexpress X.Y.Z" and the URL should be a link to the METexpress component DTC release page. - * Add Link: Link text should be "METdataio X.Y.Z" and the URL should be a link to the METdataio component DTC release page. + * Add Link: Link text should be "METplotpy X.Y.Z" and the URL should be a link to the METplotpy component DTC release page. - * Add Link: Link text should be "Documentation" and the URL should be the top - level directory of the main_vX.Y branch of the METplus User's Guide hosted on the web. - For example, use - "https://metplus.readthedocs.io/en/main_vX.Y/Users_Guide/" and NOT - "https://metplus.readthedocs.io/en/vX.Y.Z/Users_Guide/" + * Add Link: Link text should be "METcalcpy X.Y.Z" and the URL should be a link to the METcalcpy component DTC release page. - * Add Link: Link text should be "Existing Builds and Docker" and the URL - should be the latest Existing Builds page, i.e. - https://dtcenter.org/community-code/metplus/metplus-X-Y-existing-builds + * Add Link: Link text should be "METdataio X.Y.Z" and the URL should be a link to the METdataio component DTC release page. - * In the **Release Notes** text box provide direct links to the *release-notes.html* - files on the main_vX.Y branch of the User's Guide for each component. + * Add Link: Link text should be "Documentation" and the URL should be the top + level directory of the main_vX.Y branch of the METplus User's Guide hosted on the web. + For example, use + "https://metplus.readthedocs.io/en/main_vX.Y/Users_Guide/" and NOT + "https://metplus.readthedocs.io/en/vX.Y.Z/Users_Guide/" - * Click on **Create Release**. + * Add Link: Link text should be "Existing Builds and Docker" and the URL + should be the latest Existing Builds page, i.e. + https://dtcenter.org/community-code/metplus/metplus-X-Y-existing-builds - * Update any existing coordinated releases by changing the **Release Type** from - "Recommended" to "Other" and click the **Update Release** button. + * In the **Release Notes** text box provide direct links to the *release-notes.html* + files on the main_vX.Y branch of the User's Guide for each component. - * Review the existing component releases and remove any remaining development - releases (e.g. beta and rc) for any of the official releases included in this - coordinated release. + * Click on **Create Release**. - * Click on **Save** at the bottom of the page. + * Update any existing coordinated releases by changing the **Release Type** from + "Recommended" to "Other" and click the **Update Release** button. -* Create a new **Existing Builds and Docker** page for the next coordinated release. + * Review the existing component releases and remove any remaining development + releases (e.g. beta and rc) for any of the official releases included in this + coordinated release. + + * Click on **Save** at the bottom of the page. + + * Create a new **Existing Builds and Docker** page for the next coordinated release. From 0615f98c0acbc99734cb72f779c1b40fb4a8f23b Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Wed, 20 Sep 2023 14:13:17 -0600 Subject: [PATCH 4/5] Per #2156, update the finalize_release_on_github instructions to use dropdowns and clarify where/how to modify the cycle begin/end dates as requested by @fisherhucar --- .../release_steps/create_release_extra.rst | 2 +- .../finalize_release_on_github_bugfix.rst | 18 +++++-- ...finalize_release_on_github_development.rst | 21 +++++++-- .../finalize_release_on_github_official.rst | 47 ++++++++++--------- ...finalize_release_on_github_development.rst | 9 +++- .../metplus/create_release_extra.rst | 2 +- 6 files changed, 64 insertions(+), 35 deletions(-) diff --git a/docs/Release_Guide/release_steps/create_release_extra.rst b/docs/Release_Guide/release_steps/create_release_extra.rst index a5aea726b..51830cdcc 100644 --- a/docs/Release_Guide/release_steps/create_release_extra.rst +++ b/docs/Release_Guide/release_steps/create_release_extra.rst @@ -1,3 +1,3 @@ -* If this is a development release, check the box that says "This is a pre-release" +* 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/finalize_release_on_github_bugfix.rst b/docs/Release_Guide/release_steps/finalize_release_on_github_bugfix.rst index 0f0289a16..53a68993d 100644 --- a/docs/Release_Guide/release_steps/finalize_release_on_github_bugfix.rst +++ b/docs/Release_Guide/release_steps/finalize_release_on_github_bugfix.rst @@ -1,8 +1,16 @@ Finalize Release on GitHub -------------------------- -* Close the GitHub issue for creating this bugfix release. -* Edit the milestone for the current release by updating the *Due date* with the actual release date. -* Create a new milestone for the next bugfix release (e.g. '|projectRepo| X.Y.{Z+1} (bugfix)'). -* If necessary, reassign any remaining issues for the current bugfix milestone to the next one. -* Close the current bugfix milestone. +Return to GitHub to finalize the details of this release. + +.. dropdown:: Instructions + + * Close the GitHub issue for creating this bugfix release. + + * Edit the milestone for the current release by updating the *Due date* with the actual release date. + + * Create a new milestone for the next bugfix release (e.g. '|projectRepo| X.Y.{Z+1} (bugfix)'). + + * If necessary, reassign any remaining issues for the current bugfix milestone to the next one. + + * Close the current bugfix milestone. diff --git a/docs/Release_Guide/release_steps/finalize_release_on_github_development.rst b/docs/Release_Guide/release_steps/finalize_release_on_github_development.rst index 194b758c0..44499c7f4 100644 --- a/docs/Release_Guide/release_steps/finalize_release_on_github_development.rst +++ b/docs/Release_Guide/release_steps/finalize_release_on_github_development.rst @@ -1,7 +1,20 @@ Finalize Release on GitHub -------------------------- -* Close the GitHub issue for creating this development release. -* Edit the date of the development cycle for the current release to indicate the actual release date. -* Review the remaining development cycles, and if neccessary, adjust dates and/or add new cycles. -* If necessary, reassign any remaining issues for the current development cycle to the next one. +Return to GitHub to finalize the details of this release. + +.. dropdown:: Instructions + + * Close the GitHub issue for creating this development release. + + * Review the development cycles and adjust their begin and end dates, as needed. + + * From the GitHub development project, click in the top-right corner to locate and edit the "Settings". + + * From the list of "Custom fields", select "Cycle". + + * Shift the *next* "Active" development cycle forward to begin the day after the current release, if applicable. + + * Find the recently "Completed" development cycle for the current release and modify the end date to match the actual date of the current release, if applicable. + + * If necessary, reassign any remaining issues for the current development cycle to the next one. diff --git a/docs/Release_Guide/release_steps/finalize_release_on_github_official.rst b/docs/Release_Guide/release_steps/finalize_release_on_github_official.rst index 0fd714ccf..f9264d225 100644 --- a/docs/Release_Guide/release_steps/finalize_release_on_github_official.rst +++ b/docs/Release_Guide/release_steps/finalize_release_on_github_official.rst @@ -1,40 +1,43 @@ Finalize Release on GitHub -------------------------- -* Update milestones: +Return to GitHub to finalize the details of this release. - * Edit the milestone for the current release by updating the *Due date* with the actual release date. +.. dropdown:: Instructions - * Close the current milestone. + * Update milestones: - * Create a new milestone for the first bugfix release (e.g. first vX.Y.1 (bugfix) release). + * Edit the milestone for the current release by updating the *Due date* with the actual release date. - * If necessary, create a new milestone for the next official release (e.g. next vX.Y.Z release). + * Close the current milestone. -* Update issues: + * Create a new milestone for the first bugfix release (e.g. first vX.Y.1 (bugfix) release). - * Close the GitHub issue for creating this official release. + * If necessary, create a new milestone for the next official release (e.g. next vX.Y.Z release). - * If necessary, reassign any remaining issues for the current milestone to other milestones. + * Update issues: -* Update projects: + * Close the GitHub issue for creating this official release. - * Close the existing development project for the current milestone. + * If necessary, reassign any remaining issues for the current milestone to other milestones. - * If necessary, see :ref:`wo-development-project` to create a development project for the - next milestone. + * Update projects: -* Update branches: + * Close the existing development project for the current milestone. - * Remove any remaining stale development branches from the new release. + * If necessary, see :ref:`wo-development-project` to create a development project for the next milestone. - * Update the repository settings by resetting the *Default branch* to the new main_vX.Y branch: + * Update branches: -.. parsed-literal:: + * Remove any remaining stale development branches from the new release. - https://github.com/dtcenter/|projectRepo| - -> Settings - -> Scroll down to the *Default branch* section - -> Click the stacked arrows button next to default branch name - -> Select the new default branch from the dropdown list - -> Click the *Update* button + * Update the repository settings by resetting the *Default branch* to the new main_vX.Y branch: + + .. parsed-literal:: + + https://github.com/dtcenter/|projectRepo| + -> Settings + -> Scroll down to the *Default branch* section + -> Click the stacked arrows button next to default branch name + -> Select the new default branch from the dropdown list + -> Click the *Update* button diff --git a/docs/Release_Guide/release_steps/metexpress/finalize_release_on_github_development.rst b/docs/Release_Guide/release_steps/metexpress/finalize_release_on_github_development.rst index 9c84f4e3b..2b5dca8f7 100644 --- a/docs/Release_Guide/release_steps/metexpress/finalize_release_on_github_development.rst +++ b/docs/Release_Guide/release_steps/metexpress/finalize_release_on_github_development.rst @@ -1,5 +1,10 @@ Finalize Release on GitHub ---------------------------- -* Close the GitHub issue for creating this development release. -* Any code changes will be automatically incorporated into METexpress development container builds once the pull request is approved. +Return to GitHub to finalize the details of this release. + +.. dropdown:: Instructions + + * Close the GitHub issue for creating this development release. + + * Any code changes will be automatically incorporated into METexpress development container builds once the pull request is approved. diff --git a/docs/Release_Guide/release_steps/metplus/create_release_extra.rst b/docs/Release_Guide/release_steps/metplus/create_release_extra.rst index 1257ed86b..1a30f2322 100644 --- a/docs/Release_Guide/release_steps/metplus/create_release_extra.rst +++ b/docs/Release_Guide/release_steps/metplus/create_release_extra.rst @@ -4,6 +4,6 @@ Refer to a previous release to easily copy and modify this information. * If this is a development release, check the box that says "This is a pre-release" - and uncheck "Set as latest release" + and uncheck "Set as latest release". * Click on "Publish release". From d032550c55b6b6515d1697ea4b197014911bcf05 Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Fri, 22 Sep 2023 13:04:43 -0600 Subject: [PATCH 5/5] Update docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst Co-authored-by: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> --- .../release_steps/coordinated/release_acceptance_testing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst b/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst index 8f290da7c..492aac550 100644 --- a/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst +++ b/docs/Release_Guide/release_steps/coordinated/release_acceptance_testing.rst @@ -11,7 +11,7 @@ cycles of the METplus components included in a coordinated release. * Navigate to the `Release Acceptance Testing `_ discussion for this coordinated release. - * Review the repository testing tables for the METplus components within the body of the discussion. + * Review the repository testing tables for the METplus components within the body of the discussion by clicking on the dropdown icon "Repository Testing" for the appropriate METplus component to expand the hidden table. * Check the **Status** column in these tables and look for entries still marked as **OPEN** or **FAIL**. For a coordinated release, the status for all table entries should be **PASS**. * Click on the **Close discussion** button at the bottom discussion.