Skip to content

Commit

Permalink
Per #2156, update the finalize_release_on_github instructions to use …
Browse files Browse the repository at this point in the history
…dropdowns and clarify where/how to modify the cycle begin/end dates as requested by @fisherhucar
  • Loading branch information
JohnHalleyGotway committed Sep 20, 2023
1 parent 8449f4c commit 0615f98
Show file tree
Hide file tree
Showing 6 changed files with 64 additions and 35 deletions.
2 changes: 1 addition & 1 deletion docs/Release_Guide/release_steps/create_release_extra.rst
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".
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.
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.
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
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.
Original file line number Diff line number Diff line change
Expand Up @@ -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".

0 comments on commit 0615f98

Please sign in to comment.