forked from dtcenter/METplus
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feature dtcenter#2156 release_acceptance_testing take2 (dtcenter#2361)
Co-authored-by: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com>
- Loading branch information
1 parent
0e066a8
commit 71a6e23
Showing
9 changed files
with
159 additions
and
121 deletions.
There are no files selected for viewing
94 changes: 49 additions & 45 deletions
94
docs/Release_Guide/release_steps/common/update_dtc_website.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 <https://dtcenter.org>`_. | ||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
81 changes: 43 additions & 38 deletions
81
docs/Release_Guide/release_steps/coordinated/update_dtc_website.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 <https://dtcenter.org>`_. | ||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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". |
18 changes: 13 additions & 5 deletions
18
docs/Release_Guide/release_steps/finalize_release_on_github_bugfix.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
21 changes: 17 additions & 4 deletions
21
docs/Release_Guide/release_steps/finalize_release_on_github_development.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
47 changes: 25 additions & 22 deletions
47
docs/Release_Guide/release_steps/finalize_release_on_github_official.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
9 changes: 7 additions & 2 deletions
9
...lease_Guide/release_steps/metexpress/finalize_release_on_github_development.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters