Skip to content

Commit

Permalink
Per #673, after creating the MET-10.1.0 release update the release gu…
Browse files Browse the repository at this point in the history
…ide with details listed in this GitHub issue comment: #673 (comment)
  • Loading branch information
JohnHalleyGotway committed Mar 15, 2022
1 parent c8aa3f4 commit d98cadc
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 12 deletions.
1 change: 1 addition & 0 deletions docs/Release_Guide/met_official.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
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::
https://github.com/dtcenter/|projectRepo|
-> Settings
-> Branches (tab on left)
-> change the drop down to new branch
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion docs/Release_Guide/release_steps/open_release_issue.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit d98cadc

Please sign in to comment.