From 0f2a11bffa4e6562fb9c38f9be6f59c5af4ed5d5 Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Wed, 2 Aug 2023 10:59:11 -0600 Subject: [PATCH 01/11] Per #2282, add hooks for coordinated release instructions --- docs/Release_Guide/coordinated.rst | 7 ++++ docs/Release_Guide/index.rst | 60 +++++++++++++++++------------- 2 files changed, 41 insertions(+), 26 deletions(-) create mode 100644 docs/Release_Guide/coordinated.rst diff --git a/docs/Release_Guide/coordinated.rst b/docs/Release_Guide/coordinated.rst new file mode 100644 index 0000000000..f137612dda --- /dev/null +++ b/docs/Release_Guide/coordinated.rst @@ -0,0 +1,7 @@ +******************** +Coordindated Release +******************** + +.. |projectRepo| replace:: Coordinated + +Create a new METplus coordinated release from vX.Y.Z official releases for each METplus component. diff --git a/docs/Release_Guide/index.rst b/docs/Release_Guide/index.rst index 6956f5311c..9e781a0ba6 100644 --- a/docs/Release_Guide/index.rst +++ b/docs/Release_Guide/index.rst @@ -12,6 +12,32 @@ releases and is not intended for users of the software.** Stages of the METplus Release Cycle =================================== +Coordinated Release +------------------- + +A coordinated release is a group of official or bugfix releases for each +of the METplus components that have been developed and tested in parallel. +Coordinated release announcements on the +`DTC METplus Downloads `_ +page link to the component releases that comprise the coordinated release. +When bugfix releases are issued for any METplus component, the corresponding +coordinated release announcement is updated to link to the most recent bugfix +version. + +Official Release +---------------- + +An official release is a stable release and is basically the release +candidate, which has passed all tests. It is the version of the code that +has been tested as thoroughly as possible and is reliable enough to be +used in production. + +Bugfix Release +-------------- + +A bugfix release introduces no new features, but fixes bugs in previous +official releases and targets the most critical bugs affecting users. + Development Release ------------------- @@ -36,20 +62,6 @@ new source code will be added to this release. There may still be source code changes to fix bugs, changes to documentation, and changes to test cases or utilities. -Official Release ----------------- - -An official release is a stable release and is basically the release -candidate, which has passed all tests. It is the version of the code that -has been tested as thoroughly as possible and is reliable enough to be -used in production. - -Bugfix Release --------------- - -A bugfix release introduces no new features, but fixes bugs in previous -official releases and targets the most critical bugs affecting users. - Release Support Policy ====================== @@ -68,7 +80,9 @@ to report any bugs, please contact our dedicated support team in the Instructions Summary ==================== -Instructions are provided for three types of software releases: +Instructions are provided for the following types of software releases: + +#. **Coordinated Release** consisting of a group of software component releases #. **Official Release** (e.g. vX.Y.Z) from the develop branch (becomes the new main_vX.Y branch) @@ -76,16 +90,18 @@ Instructions are provided for three types of software releases: #. **Development Release** (e.g. vX.Y.Z-betaN or vX.Y.Z-rcN) from the develop branch -The instructions that are common to all components are documented only once and then included in the release steps for all components. -However some instructions are specific to individual repositories and documented separately. +The instructions that are common to all components are documented only once and then included +in the release steps for all components. However some instructions are specific to individual +repositories and documented separately. -Release instructions for each of the METplus components are described in the following chapters. +Release instructions are described in the following chapters. .. toctree:: :titlesonly: :maxdepth: 1 :numbered: 4 + coordinated metplus met metdataio @@ -94,11 +110,3 @@ Release instructions for each of the METplus components are described in the fol metviewer metexpress recreate_release - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` From 0bb80c7ad16853b7e332d4c691cd5a96e54007b7 Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Wed, 2 Aug 2023 12:55:46 -0600 Subject: [PATCH 02/11] Per #2282, update to more concise 'Release Types' title. --- docs/Contributors_Guide/github_workflow.rst | 4 +-- docs/Release_Guide/index.rst | 37 +++++++++++---------- docs/Users_Guide/release-notes.rst | 2 +- 3 files changed, 23 insertions(+), 20 deletions(-) diff --git a/docs/Contributors_Guide/github_workflow.rst b/docs/Contributors_Guide/github_workflow.rst index fd1451778d..308c47f165 100644 --- a/docs/Contributors_Guide/github_workflow.rst +++ b/docs/Contributors_Guide/github_workflow.rst @@ -34,7 +34,7 @@ time window for that cycle or reassigned to a future development cycle. Each development cycle culminates in the creation of a software release. The -:ref:`releaseCycleStages` section describes the various types of software releases +:ref:`releaseTypes` section describes the various types of software releases (development, official, or bugfix). Each development cycle culminates in a beta release, a release candidate, or the official release. Generally, a **beta** development cycle results in a **beta** development release while an **rc** development cycle results in an **rc** @@ -180,7 +180,7 @@ to that support project. Each fix is assigned to the current bugfix milestone o the corresponding source code repository. -The :ref:`releaseCycleStages` section describes the various types of software releases +The :ref:`releaseTypes` section describes the various types of software releases (development, official, or bugfix). The GitHub support project contains issues and pull requests that apply only to bugfix releases. diff --git a/docs/Release_Guide/index.rst b/docs/Release_Guide/index.rst index 9e781a0ba6..0bed03d471 100644 --- a/docs/Release_Guide/index.rst +++ b/docs/Release_Guide/index.rst @@ -4,18 +4,20 @@ Release Guide This METplus Release Guide provides detailed instructions for METplus developers for creating software releases for the METplus component -repositories. **This Release Guide is intended for developers creating -releases and is not intended for users of the software.** +repositories. -.. _releaseCycleStages: +.. note:: This Release Guide is intended for developers creating + releases and is not intended for users of the software. -Stages of the METplus Release Cycle -=================================== +.. _releaseTypes: + +Release Types +============= Coordinated Release ------------------- -A coordinated release is a group of official or bugfix releases for each +A METplus coordinated release is a group of official or bugfix releases for each of the METplus components that have been developed and tested in parallel. Coordinated release announcements on the `DTC METplus Downloads `_ @@ -27,16 +29,17 @@ version. Official Release ---------------- -An official release is a stable release and is basically the release -candidate, which has passed all tests. It is the version of the code that -has been tested as thoroughly as possible and is reliable enough to be +An official release is a stable release of a METplus component and is basically +the release candidate, which has passed all tests. It is the version of the +code that has been tested as thoroughly as possible and is reliable enough to be used in production. Bugfix Release -------------- -A bugfix release introduces no new features, but fixes bugs in previous -official releases and targets the most critical bugs affecting users. +A bugfix release for a METplus component introduces no new features, but fixes +bugs in previous official releases and targets the most critical bugs affecting +users. Development Release ------------------- @@ -44,9 +47,9 @@ Development Release Beta ^^^^ -Beta releases are a pre-release of the software to give a larger group of -users the opportunity to test the recently incorporated new features, -enhancements, and bug fixes. Beta releases allow for continued +Beta releases are a pre-release of a METplus software component to give a +larger group of users the opportunity to test the recently incorporated new +features, enhancements, and bug fixes. Beta releases allow for continued development and bug fixes before an official release. There are many possible configurations of hardware and software that exist and installation of beta releases allow for testing of potential conflicts. @@ -54,9 +57,9 @@ of beta releases allow for testing of potential conflicts. Release Candidate (rc) ^^^^^^^^^^^^^^^^^^^^^^ -A release candidate is a version of the software that is nearly ready for -official release but may still have a few bugs. At this stage, all product -features have been designed, coded, and tested through one or more beta +A release candidate is a version of a METplus software component that is nearly +ready for official release but may still have a few bugs. At this stage, all +product features have been designed, coded, and tested through one or more beta cycles with no known bugs. It is code complete, meaning that no entirely new source code will be added to this release. There may still be source code changes to fix bugs, changes to documentation, and changes to test diff --git a/docs/Users_Guide/release-notes.rst b/docs/Users_Guide/release-notes.rst index afbdbf872a..586318c044 100644 --- a/docs/Users_Guide/release-notes.rst +++ b/docs/Users_Guide/release-notes.rst @@ -4,7 +4,7 @@ METplus Release Information .. _release-notes: -Users can view the :ref:`releaseCycleStages` section of +Users can view the :ref:`releaseTypes` section of the Release Guide for descriptions of the development releases (including beta releases and release candidates), official releases, and bugfix releases for the METplus Components. From 512de9f98b570bceb61daaed35adfe4a3eeaefdc Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Wed, 2 Aug 2023 14:47:04 -0600 Subject: [PATCH 03/11] Per #2282, refine the MET update DTC website instructions. --- docs/Release_Guide/coordinated.rst | 27 ++++++++++++++++--- .../release_steps/met/update_dtc_website.rst | 2 +- 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/docs/Release_Guide/coordinated.rst b/docs/Release_Guide/coordinated.rst index f137612dda..8b9486f255 100644 --- a/docs/Release_Guide/coordinated.rst +++ b/docs/Release_Guide/coordinated.rst @@ -1,7 +1,26 @@ -******************** -Coordindated Release -******************** +******************* +Coordinated Release +******************* .. |projectRepo| replace:: Coordinated -Create a new METplus coordinated release from vX.Y.Z official releases for each METplus component. +Create a new METplus coordinated release from vX.Y.Z official or +bugfix releases of the METplus components. Typically, a coordinated +release consists entirely of official releases prior to any bugfix +releases being issued. However, the latter is certainly possible. +In fact, whenever a bugfix release is created for a METplus component, +the corresponding coordinated release is updated to link to the most +recent bugfix version. + +The following instructions assume that all of the official or +bugfix component releases have already been created. Note however that +some of these steps can be started prior the completion of the +component releases. + +.. include:: release_steps/metplus/update_dtc_website.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 +.. include:: release_steps/metplus/update_zenodo.rst +.. include:: release_steps/set_beta_deletion_reminder_official.rst diff --git a/docs/Release_Guide/release_steps/met/update_dtc_website.rst b/docs/Release_Guide/release_steps/met/update_dtc_website.rst index 064eecf01a..351ddd8ef7 100644 --- a/docs/Release_Guide/release_steps/met/update_dtc_website.rst +++ b/docs/Release_Guide/release_steps/met/update_dtc_website.rst @@ -2,6 +2,6 @@ .. |projectName| replace:: |projectRepo| -.. |addTarfileStep| replace:: Link text should be the file name of the tar file and the URL should be the .tar.gz file created in the "Attach Release Tarfile" step. +.. |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. .. |otherWebsiteUpdates| replace:: Make any other necessary website updates. For example, the flowchart at https://dtcenter.org/community-code/model-evaluation-tools-met/system-architecture. From 03ce222585019090d812dd71bbb46466098084d4 Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Wed, 2 Aug 2023 16:28:50 -0600 Subject: [PATCH 04/11] Per #2282, more updates. --- docs/Contributors_Guide/github_workflow.rst | 2 +- docs/Release_Guide/coordinated.rst | 15 ++--- docs/Release_Guide/metplus_official.rst | 1 - .../common/update_dtc_website.rst | 22 ++----- .../coordinated/announce_release.rst | 6 ++ .../finalize_release_on_github.rst | 5 ++ .../coordinated/update_dtc_website.rst | 66 +++++++++++++++++++ .../update_zenodo.rst | 0 .../finalize_release_on_github_official.rst | 3 - 9 files changed, 91 insertions(+), 29 deletions(-) create mode 100644 docs/Release_Guide/release_steps/coordinated/announce_release.rst create mode 100644 docs/Release_Guide/release_steps/coordinated/finalize_release_on_github.rst create mode 100644 docs/Release_Guide/release_steps/coordinated/update_dtc_website.rst rename docs/Release_Guide/release_steps/{metplus => coordinated}/update_zenodo.rst (100%) diff --git a/docs/Contributors_Guide/github_workflow.rst b/docs/Contributors_Guide/github_workflow.rst index 308c47f165..dbaf746374 100644 --- a/docs/Contributors_Guide/github_workflow.rst +++ b/docs/Contributors_Guide/github_workflow.rst @@ -204,7 +204,7 @@ required to perform the following steps. and select **Settings**. Modify these settings as follows. - Project name: The default project name is **@UserNames's feature**. Rename it as - **METplus Version X.Y Support** (e.g. **METplus Version 5.0 Support**). + **Coorindated METplus-X.Y Support** (e.g. **Coordinated METplus-5.0 Support**). - Add a description: Add **Issues related to support for the METplus X.Y coordinated release.** diff --git a/docs/Release_Guide/coordinated.rst b/docs/Release_Guide/coordinated.rst index 8b9486f255..974d6f2deb 100644 --- a/docs/Release_Guide/coordinated.rst +++ b/docs/Release_Guide/coordinated.rst @@ -6,8 +6,8 @@ Coordinated Release Create a new METplus coordinated release from vX.Y.Z official or bugfix releases of the METplus components. Typically, a coordinated -release consists entirely of official releases prior to any bugfix -releases being issued. However, the latter is certainly possible. +release consists entirely of official component releases prior to any +bugfix releases being issued. However, the latter is certainly possible. In fact, whenever a bugfix release is created for a METplus component, the corresponding coordinated release is updated to link to the most recent bugfix version. @@ -17,10 +17,7 @@ bugfix component releases have already been created. Note however that some of these steps can be started prior the completion of the component releases. -.. include:: release_steps/metplus/update_dtc_website.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 -.. include:: release_steps/metplus/update_zenodo.rst -.. include:: release_steps/set_beta_deletion_reminder_official.rst +.. include:: release_steps/coordinated/update_dtc_website.rst +.. include:: release_steps/coordinated/finalize_release_on_github_official.rst +.. include:: release_steps/coordinated/update_zenodo.rst +.. include:: release_steps/coordinated/announce_release.rst diff --git a/docs/Release_Guide/metplus_official.rst b/docs/Release_Guide/metplus_official.rst index f2a9acb2d3..a2d77cac9d 100644 --- a/docs/Release_Guide/metplus_official.rst +++ b/docs/Release_Guide/metplus_official.rst @@ -24,5 +24,4 @@ Create a new vX.Y.Z official release from the develop branch. .. 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 -.. include:: release_steps/metplus/update_zenodo.rst .. include:: release_steps/set_beta_deletion_reminder_official.rst 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 bbd39bc68d..31baeb0016 100644 --- a/docs/Release_Guide/release_steps/common/update_dtc_website.rst +++ b/docs/Release_Guide/release_steps/common/update_dtc_website.rst @@ -6,22 +6,22 @@ Update DTC Website * Navigate to the downloads page for the |projectRepo| repository at https://dtcenter.org/community-code/metplus/download -* Click on the Edit button to edit the Downloads page. +* Click on the *Edit* button to edit the Downloads page. * Create a new *Software Release* for the newly released version by clicking on *Add New Release*. * For *Full Title of Release* type "|projectRepo| Version X.Y.Z". - * For *Related Community Code* select both the METplus and the |projectName| + * For *Related Community Code* select both the "METplus" and the "|projectName|" options (For Macs, hold the Command key to select both). * For *Version Label* type "|projectRepo| X.Y.Z-betaN". - * Select the release type (*Recommended* for official or bugfix releases or - *Development* for development versions). + * Select the *Release Type* ("Recommended" for official or bugfix releases or + "Development" for development versions). - * Enter the release date. + * Enter the *Release Date*. * Click on *Add Code Download* then click *Add Link* to add links for each of the following: @@ -58,18 +58,10 @@ Update DTC Website * For an official release, remove the corresponding development releases. - * Create or edit the "Coordinated METplus Version X.Y" software release. - - * For an official release, create the "Coordinated METplus Version X.Y" - release entry if it doesn't already exist. Ensure the "Release Type" - is set to *Recommended*. Consider changing the "Release Type" of - previous coordinated releases from *Recommended* to *Other*. Add - links for the |projectRepo| X.Y.Z, the METplus "Documentation", - the METplus "Existing Builds and Docker" page, and the "Release Notes". - Make the Release Notes a link to the |projectRepo| Release Notes. + * Edit the "Coordinated METplus Version X.Y" software release. * For a bugfix release, update the existing link and text in - the "Coordinated METplus Version X.Y" release section with the + the "Coordinated METplus-X.Y" release section with the X.Y.Z+1 information. * |otherWebsiteUpdates| diff --git a/docs/Release_Guide/release_steps/coordinated/announce_release.rst b/docs/Release_Guide/release_steps/coordinated/announce_release.rst new file mode 100644 index 0000000000..9a29d68c9e --- /dev/null +++ b/docs/Release_Guide/release_steps/coordinated/announce_release.rst @@ -0,0 +1,6 @@ +Announce Release +---------------- + +* Contact the METplus project manager to announce the coordinated release via email. + +* Contact the RAL-IT group to request that the coordinated release components be installed in */usr/local* to be used on all RAL machines. diff --git a/docs/Release_Guide/release_steps/coordinated/finalize_release_on_github.rst b/docs/Release_Guide/release_steps/coordinated/finalize_release_on_github.rst new file mode 100644 index 0000000000..94172b01b8 --- /dev/null +++ b/docs/Release_Guide/release_steps/coordinated/finalize_release_on_github.rst @@ -0,0 +1,5 @@ +Finalize Release on GitHub +-------------------------- + +See :ref:`wo-support-project` to create a support project for +the current METplus coordinated release. diff --git a/docs/Release_Guide/release_steps/coordinated/update_dtc_website.rst b/docs/Release_Guide/release_steps/coordinated/update_dtc_website.rst new file mode 100644 index 0000000000..25a09c041a --- /dev/null +++ b/docs/Release_Guide/release_steps/coordinated/update_dtc_website.rst @@ -0,0 +1,66 @@ +Update DTC Website +------------------ + +* Navigate to https://dtcenter.org and sign in to the Drupal interface. + +* Navigate to the METplus downloads page at + https://dtcenter.org/community-code/metplus/download + +* Click on the *Edit* button to edit the Downloads page. + +* Create a new *Software Release* for the new coordinated release by clicking + on *Add New Release*. + + * For *Full Title of Release* type "Coorindated METplus X.Y". + + * For *Related Community Code* select only the "METplus" option. + + * For *Version Label* type "Coordinated METplus X.Y". + + * Select the *Release Type* as "Recommended". + + * Select the *Release Options* as "Coordinated". + + * Enter the *Release Date*. + + * Click on *Add Code Download* then click *Add Link* to add links for each of the following: + + * 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 "MET X.Y.Z" and the URL should be a link to the MET 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 "METexpress X.Y.Z" and the URL should be a link to the METexpress 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 "METcalcpy X.Y.Z" and the URL should be a link to the METcalcpy 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 "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 "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 + + * For 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. + + * Click on *Create Release*. + + * Update any existing coordinated releases by changing the *Release Type* from + "Recommended" to "Other" and click the *Update Release* button. + + * 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. diff --git a/docs/Release_Guide/release_steps/metplus/update_zenodo.rst b/docs/Release_Guide/release_steps/coordinated/update_zenodo.rst similarity index 100% rename from docs/Release_Guide/release_steps/metplus/update_zenodo.rst rename to docs/Release_Guide/release_steps/coordinated/update_zenodo.rst 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 85c366ea1b..0fed07360d 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 @@ -21,9 +21,6 @@ Finalize Release on GitHub * Close the existing development project for the current milestone. - * If necessary, see :ref:`wo-support-project` to create a support project for the current - METplus coordinated release. - * If necessary, see :ref:`wo-development-project` to create a development project for the next milestone. From 2c9bd263a4306acc568b2a26013cc00143facc95 Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Wed, 2 Aug 2023 16:46:47 -0600 Subject: [PATCH 05/11] Per #2282, switching from italics to bold in the update_dtc_website instructions. This is very subjective an can easily be backed out if the PR reviewers don't like the change. --- .../common/update_dtc_website.rst | 30 ++++++++--------- .../coordinated/update_dtc_website.rst | 32 +++++++++---------- 2 files changed, 31 insertions(+), 31 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 31baeb0016..a72e79dc1d 100644 --- a/docs/Release_Guide/release_steps/common/update_dtc_website.rst +++ b/docs/Release_Guide/release_steps/common/update_dtc_website.rst @@ -6,24 +6,24 @@ Update DTC Website * Navigate to the downloads page for the |projectRepo| repository at https://dtcenter.org/community-code/metplus/download -* Click on the *Edit* button to edit the Downloads page. +* Click on the **Edit** button to edit the Downloads page. -* Create a new *Software Release* for the newly released version by clicking - on *Add New Release*. +* Create a new **Software Release** for the newly released version by clicking + on **Add New Release**. - * For *Full Title of Release* type "|projectRepo| Version X.Y.Z". + * For **Full Title of Release** type "|projectRepo| Version X.Y.Z". - * For *Related Community Code* select both the "METplus" and the "|projectName|" + * For **Related Community Code** select both the "METplus" and the "|projectName|" options (For Macs, hold the Command key to select both). - * For *Version Label* type "|projectRepo| X.Y.Z-betaN". + * For **Version Label** type "|projectRepo| X.Y.Z-betaN". - * Select the *Release Type* ("Recommended" for official or bugfix releases or + * Select the **Release Type** ("Recommended" for official or bugfix releases or "Development" for development versions). - * Enter the *Release Date*. + * Enter the **Release Date**. - * Click on *Add Code Download* then click *Add Link* to add links for each of the following: + * Click on **Add Code Download** then click **Add Link** to add links for each of the following: * Add Link: |addTarfileStep| @@ -41,19 +41,19 @@ Update DTC Website (If creating a new official release, be sure to add a new *Existing Builds and Docker* page, if one was not already created.) - * Inside the text box in the "Release Notes" section 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. * For a development release, ensure the "Release Type" is set to - *Development* and change any previous *Development* versions to - *Other*. + **Development** and change any previous **Development** versions to + **Other**. * For a bugfix or official release, change any previous - *Recommended* versions to *Other*. + **Recommended** versions to **Other**. * For an official release, remove the corresponding development releases. 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 25a09c041a..6082e88ca5 100644 --- a/docs/Release_Guide/release_steps/coordinated/update_dtc_website.rst +++ b/docs/Release_Guide/release_steps/coordinated/update_dtc_website.rst @@ -6,24 +6,24 @@ Update DTC Website * Navigate to the METplus downloads page at https://dtcenter.org/community-code/metplus/download -* Click on the *Edit* button to edit the Downloads page. +* Click on the **Edit** button to edit the Downloads page. -* Create a new *Software Release* for the new coordinated release by clicking - on *Add New Release*. +* Create a new **Software Release** for the new coordinated release by clicking + on **Add New Release**. - * For *Full Title of Release* type "Coorindated METplus X.Y". + * For **Full Title of Release** type "Coorindated METplus X.Y". - * For *Related Community Code* select only the "METplus" option. + * For **Related Community Code** select only the "METplus" option. - * For *Version Label* type "Coordinated METplus X.Y". + * For **Version Label** type "Coordinated METplus X.Y". - * Select the *Release Type* as "Recommended". + * Select the **Release Type** as "Recommended". - * Select the *Release Options* as "Coordinated". + * Select the **Release Options** as "Coordinated". - * Enter the *Release Date*. + * Enter the **Release Date**. - * Click on *Add Code Download* then click *Add Link* to add links for each of the following: + * Click on **Add Code Download** then click **Add Link** to add links for each of the following: * Add Link: Link text should be "METplus X.Y.Z" and the URL should be a link to the METplus component DTC release page. @@ -49,18 +49,18 @@ Update DTC Website should be the latest Existing Builds page, i.e. https://dtcenter.org/community-code/metplus/metplus-X-Y-existing-builds - * For the *Release Notes* text box provide direct links to the *release-notes.html* + * 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. - * Click on *Create Release*. + * Click on **Create Release**. - * Update any existing coordinated releases by changing the *Release Type* from - "Recommended" to "Other" and click the *Update Release* button. + * Update any existing coordinated releases by changing the **Release Type** from + "Recommended" to "Other" and click the **Update Release** button. * 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. + * Click on **Save** at the bottom of the page. -* Create a new *Existing Builds and Docker* page for the next coordinated release. +* Create a new **Existing Builds and Docker** page for the next coordinated release. From a35999d210740a93ed84c8ceb7a7147c5b924296 Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Wed, 2 Aug 2023 17:17:48 -0600 Subject: [PATCH 06/11] Per #2282, fix doc build error. --- docs/Release_Guide/coordinated.rst | 2 +- docs/Release_Guide/release_steps/common/update_dtc_website.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Release_Guide/coordinated.rst b/docs/Release_Guide/coordinated.rst index 974d6f2deb..fe897a4f99 100644 --- a/docs/Release_Guide/coordinated.rst +++ b/docs/Release_Guide/coordinated.rst @@ -18,6 +18,6 @@ some of these steps can be started prior the completion of the component releases. .. include:: release_steps/coordinated/update_dtc_website.rst -.. include:: release_steps/coordinated/finalize_release_on_github_official.rst +.. include:: release_steps/coordinated/finalize_release_on_github.rst .. include:: release_steps/coordinated/update_zenodo.rst .. include:: release_steps/coordinated/announce_release.rst 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 a72e79dc1d..7f8b1be69a 100644 --- a/docs/Release_Guide/release_steps/common/update_dtc_website.rst +++ b/docs/Release_Guide/release_steps/common/update_dtc_website.rst @@ -66,5 +66,5 @@ Update DTC Website * |otherWebsiteUpdates| - * Click on "Save". + * Click on **Save** at the bottom of the page. From cada6e5ca5e2a691caf27819ee42a44ebd926aec Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Thu, 3 Aug 2023 07:49:17 -0600 Subject: [PATCH 07/11] Update docs/Release_Guide/coordinated.rst Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com> --- docs/Release_Guide/coordinated.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Release_Guide/coordinated.rst b/docs/Release_Guide/coordinated.rst index fe897a4f99..4abd404a18 100644 --- a/docs/Release_Guide/coordinated.rst +++ b/docs/Release_Guide/coordinated.rst @@ -13,7 +13,7 @@ the corresponding coordinated release is updated to link to the most recent bugfix version. The following instructions assume that all of the official or -bugfix component releases have already been created. Note however that +bugfix component releases have already been created. Note, however, that some of these steps can be started prior the completion of the component releases. From 76a074f1ec01994c90860b99fbadb61caedca016 Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Thu, 3 Aug 2023 07:50:03 -0600 Subject: [PATCH 08/11] Update docs/Release_Guide/index.rst Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com> --- docs/Release_Guide/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Release_Guide/index.rst b/docs/Release_Guide/index.rst index 0bed03d471..c3a41a4f9f 100644 --- a/docs/Release_Guide/index.rst +++ b/docs/Release_Guide/index.rst @@ -29,7 +29,7 @@ version. Official Release ---------------- -An official release is a stable release of a METplus component and is basically +An official release is a stable release of a METplus component and typically matches the release candidate, which has passed all tests. It is the version of the code that has been tested as thoroughly as possible and is reliable enough to be used in production. From 13d99816eea01f4d57f4dc82e797c8e26caf2398 Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Thu, 3 Aug 2023 07:50:40 -0600 Subject: [PATCH 09/11] Update docs/Release_Guide/index.rst Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com> --- docs/Release_Guide/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Release_Guide/index.rst b/docs/Release_Guide/index.rst index c3a41a4f9f..bde0abc8d8 100644 --- a/docs/Release_Guide/index.rst +++ b/docs/Release_Guide/index.rst @@ -87,7 +87,7 @@ Instructions are provided for the following types of software releases: #. **Coordinated Release** consisting of a group of software component releases -#. **Official Release** (e.g. vX.Y.Z) from the develop branch (becomes the new main_vX.Y branch) +#. **Official Release** (e.g. vX.Y.0) from the develop branch (becomes the new main_vX.Y branch) #. **Bugfix Release** (e.g. vX.Y.Z) from the corresponding main_vX.Y branch From 4bc8c332aaab5b844e72d9de18dad67085ce3522 Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Thu, 3 Aug 2023 10:17:22 -0600 Subject: [PATCH 10/11] Per #2282, update to reflect the METplus-Wrappers development project naming convention. --- docs/Contributors_Guide/github_workflow.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Contributors_Guide/github_workflow.rst b/docs/Contributors_Guide/github_workflow.rst index dbaf746374..4b623a69c7 100644 --- a/docs/Contributors_Guide/github_workflow.rst +++ b/docs/Contributors_Guide/github_workflow.rst @@ -63,7 +63,7 @@ are required to perform the following steps. and select **Settings**. Modify these settings as follows. - Project name: The default project name is **@UserNames's feature**. Rename it as - **{METplus Component}-{Target Version Number} Development** (e.g. **METplus-5.1.0 Development**). + **{METplus Component}-{Target Version Number} Development** (e.g. **METplus-Wrappers-5.1.0 Development**). - Add a description: Add **Development toward {METplus Component} version {Target Version Number}.** From 4c9794547e41a04ef5ce9ab93050a842dfdb51a0 Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Thu, 3 Aug 2023 10:57:59 -0600 Subject: [PATCH 11/11] Per #2282, update default branch instructions --- .../release_steps/finalize_release_on_github_official.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) 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 0fed07360d..0fd714ccfe 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 @@ -34,6 +34,7 @@ Finalize Release on GitHub https://github.com/dtcenter/|projectRepo| -> Settings - -> Branches (tab on left) - -> change the drop down to new branch (click on stacked arrows icon next to the edit icon) - -> update branch protection rules + -> 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