From d98cadca9720f3eae3ab73b1657f084c58189db3 Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Tue, 15 Mar 2022 16:29:30 -0600 Subject: [PATCH] Per #673, after creating the MET-10.1.0 release update the release guide with details listed in this GitHub issue comment: https://github.com/dtcenter/METplus/issues/673#issuecomment-838614301 --- docs/Release_Guide/met_official.rst | 1 + .../create_release_on_github.rst | 3 +- .../finalize_release_on_github_official.rst | 23 +++++++----- .../met/create_release_reference_branch.rst | 35 +++++++++++++++++++ .../release_steps/open_release_issue.rst | 2 +- 5 files changed, 52 insertions(+), 12 deletions(-) create mode 100644 docs/Release_Guide/release_steps/met/create_release_reference_branch.rst diff --git a/docs/Release_Guide/met_official.rst b/docs/Release_Guide/met_official.rst index 1cf1457509..7bef52530a 100644 --- a/docs/Release_Guide/met_official.rst +++ b/docs/Release_Guide/met_official.rst @@ -13,6 +13,7 @@ Create a new vX.Y.Z official release from the develop branch. .. include:: release_steps/update_release_notes_official.rst .. include:: release_steps/rotate_authorship.rst .. include:: release_steps/merge_release_issue.rst +.. include:: release_steps/met/create_release_reference_branch.rst .. include:: release_steps/create_release_branch.rst .. include:: release_steps/create_release_on_github.rst .. include:: release_steps/create_release_extra.rst diff --git a/docs/Release_Guide/release_steps/create_release_on_github.rst b/docs/Release_Guide/release_steps/create_release_on_github.rst index a20cd4f28a..c1346b2cd0 100644 --- a/docs/Release_Guide/release_steps/create_release_on_github.rst +++ b/docs/Release_Guide/release_steps/create_release_on_github.rst @@ -13,7 +13,6 @@ Create Release on GitHub https://|projectRepo|.readthedocs.io/en/vX.Y.Z-betaN/Users_Guide/release-notes.html (Note: the URL will not be active until the release is created) -* Add a link to the PDF of the |projectRepo| User's Guide, if available. - The PDF can be downloaded from ReadTheDocs if it is available, i.e. +* Add links to the HTML and PDF versions of the |projectRepo| User's Guide on ReadTheDocs. https://|projectRepo|.readthedocs.io/_/downloads/en/vX.Y.Z-betaN/pdf/ (Note: the URL will not be active until the release is created) 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 ca2abafbd7..428575c407 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,14 +1,20 @@ Finalize Release on GitHub -------------------------- -* Close the GitHub issue for creating this official 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). -* If necessary, reassign any remaining issues for the current milestone to the next one. -* Close the current milestone. -* Confirm that all existing development projects for the current milestone are closed. -* If necessary, create development projects for the next milestone (e.g. |projectRepo|-X.Y.Z-beta1, beta2, beta3). -* Update the repository settings by resetting the *Default branch* to the new main_vX.Y branch: +* Update milestones: + * Edit the milestone for the current release by updating the *Due date* with the actual release date. + * Close the current milestone. + * Create a new milestone for the first bugfix release (e.g. first vX.Y.1 (bugfix) release). + * If necessary, create a new milestone for the next official release (e.g. next vX.Y.Z release). +* Update issues: + * Close the GitHub issue for creating this official release. + * If necessary, reassign any remaining issues for the current milestone to other milestones. +* Update projects: + * Confirm that all existing development projects for the current milestone are closed. + * If necessary, create development projects for the next milestone (e.g. |projectRepo|-X.Y.Z-beta1, beta2, beta3). +* Update branches: + * Remove any remaining stale development branches from the new release. + * Update the repository settings by resetting the *Default branch* to the new main_vX.Y branch: .. parsed-literal:: @@ -16,4 +22,3 @@ Finalize Release on GitHub -> Settings -> Branches (tab on left) -> change the drop down to new branch - diff --git a/docs/Release_Guide/release_steps/met/create_release_reference_branch.rst b/docs/Release_Guide/release_steps/met/create_release_reference_branch.rst new file mode 100644 index 0000000000..b09f83b282 --- /dev/null +++ b/docs/Release_Guide/release_steps/met/create_release_reference_branch.rst @@ -0,0 +1,35 @@ +Create Release Reference Branch +------------------------------- + +* Create a branch from the develop branch for the reference branch for the + new official release and push it to GitHub. The branch name should match + the format main_vX.Y-ref where X.Y is the major/minor release number. + +.. parsed-literal:: + + cd |projectRepo| + git checkout develop + git pull + git checkout -b main_vX.Y-ref + +Push reference branch to GitHub +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:: + + git push -u origin main_vX.Y-ref + +Pushing this branch to GitHub should trigger the GitHub Actions automation +that runs all of the use cases and creates Docker data volumes with the output +data. These data will be used to verify that any bugfixes applied to the +main_vX.Y branch does not break any of existing logic. + +Monitor GitHub Actions Workflow +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Navigate to https://github.com/dtcenter/MET/actions and verify that a +*Testing* workflow was triggered on the *main_vX.Y-ref* branch. + +* Wait until the entire workflow has run successfully. The final job entitled + "Create Output Docker Data Volumes" should create Docker data volumes for + each use case category on DockerHub (dtcenter/met-dev). diff --git a/docs/Release_Guide/release_steps/open_release_issue.rst b/docs/Release_Guide/release_steps/open_release_issue.rst index a1ea1abaec..46cdc15d83 100644 --- a/docs/Release_Guide/release_steps/open_release_issue.rst +++ b/docs/Release_Guide/release_steps/open_release_issue.rst @@ -7,7 +7,7 @@ Open Release Issue * "Create the |projectRepo| vX.Y.Z-betaN (or -rcN) release" for a development release. -* For an official or development release, assign the issue to the current |projectRepo| development project. +* For an official or development release, assign the issue to the corresponding |projectRepo| development project. * For a bugfix release, assign the issue to the organization level support project.