Skip to content

Commit

Permalink
Per #1885, update Release guide to link to the contributors guide det…
Browse files Browse the repository at this point in the history
…ails.
  • Loading branch information
JohnHalleyGotway committed Dec 1, 2022
1 parent b1c8d4b commit a37ffda
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 48 deletions.
16 changes: 11 additions & 5 deletions docs/Contributors_Guide/github_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ are required to perform the following steps.
**New** option by clicking the **X** to its right.

- Select **Iteration** and modify the **Field name** to be **Cycle**. Delete any existing cycles.
Under **More options** select a **Start on* date and set the default **Duration** as 6 weeks.
Under **More options** select a **Start on** date and set the default **Duration** as 6 weeks.
Click the **Add** and **Add iteration** buttons to create 5 cycles, each with the default duration
of 6 weeks. Modify the cycle names to be **Beta1**, **Beta2**, and so on. Click **Save changes**.

Expand Down Expand Up @@ -194,12 +194,12 @@ 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**).
**METplus Version X.Y Support** (e.g. **METplus Version 5.0 Support**).

- Add a description: Add **Issues related to support for the METplus {X.Y}
- Add a description: Add **Issues related to support for the METplus X.Y
coordinated release.**

- README: List the {X.Y} version number for each METplus component contained within
- README: List the X.Y version number for each METplus component contained within
the coordinated release.

- Scroll down to the **Danger zone** and change **Visibilty** from its default value
Expand Down Expand Up @@ -260,6 +260,13 @@ required to perform the following steps.
- The blue dot on the down arrow for this tab indicates that there are unsaved changes.
Select the **Save changes** option.

- Click on the down arrow and select **Duplicate View**. Name/refine this views as follows.

- View name **Closed Issues** shows issues that have been closed across all bugfix
milestones. Click on the 3 horizontal bars and define the filtering criteria as
**is:closed is:issue**. Click on the 3 dots in the **Milestone** column and select
**Group by values**. Click **Save Changes**.

- Delete any other views created by default by clicking the down arrow next to the view
name and selecting **Delete view**.

Expand All @@ -279,7 +286,6 @@ required to perform the following steps.

- Click the **Link a project** button and find/select this newly created support project.


Sequence of Events - Contributing Code
--------------------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ Finalize Release on GitHub
--------------------------

* Close the GitHub issue for creating this development release.
* Edit the development project name for the current release to indicate the actual release date.
* Review the remaining development projects, and if neccessary, add new ones.
* If necessary, reassign any remaining issues from the current development project to the next one.
* Close the development project for the current 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.
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,13 @@ Finalize Release on GitHub

* Update projects:

* Confirm that all existing development projects for the current milestone are closed.
* Close the existing development project for the current milestone.

* If necessary, create development projects for the next milestone (e.g. |projectRepo|-X.Y.Z-beta1, beta2, beta3).
* 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.

* Update branches:

Expand Down
14 changes: 3 additions & 11 deletions docs/Release_Guide/release_steps/update_release_notes_bugfix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,13 @@ release. Open the following URL in a browser:

.. parsed-literal::
https://github.com/orgs/dtcenter/projects?type=beta
https://github.com/orgs/dtcenter/projects
* Click on the project that corresponds to support for the release, i.e.
METplus Version X.Y Support

* Navigate to the "Closed Issues" tab.
**If this tab does not exist**, follow these instructions to create it:

* Click on "+ New view" button on the far right side of the view tabs
* Click on "View <N>" (where <N> is an integer) and rename it to
"Closed Issues"
* Click on the down arrow next to the newly created view
* Click on "Search or filter this view"
* Enter the following info into the filter bar: **is:closed is:issue**
* Click on the down arrow next to the view and click "Save changes"
* Navigate to the "Closed Issues" tab. If this tab does not exist,
see :ref:`wo-support-project` to create it.

* Find the closed issues with dtcenter/|projectRepo| in the Repository column
that have been added since the last bugfix release for |projectRepo|.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,13 @@ release. Open the following URL in a browser:

.. parsed-literal::
https://github.com/orgs/dtcenter/projects?type=beta
https://github.com/orgs/dtcenter/projects
* Click on the project that corresponds to this release, i.e.
|projectRepo|-X.Y.Z-betaN

* Navigate to the "Closed Issues" tab.
**If this tab does not exist**, follow these instructions to create it:

* Click on "+ New view" button on the far right side of the view tabs
* Click on "View <N>" (where <N> is an integer) and rename it to
"Closed Issues"
* Click on the down arrow next to the newly created view
* Click on "Search or filter this view"
* Enter the following info into the filter bar: **is:closed is:issue**
* Click on the down arrow next to the view and click "Save changes"
|projectRepo|-X.Y.Z Development

* Navigate to the "Closed Issues" tab. If this tab does not exist,
see :ref:`wo-development-project` to create it.

* Update the release-notes.rst file found in the User's Guide directory.

Expand Down
18 changes: 5 additions & 13 deletions docs/Release_Guide/release_steps/update_release_notes_official.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,13 @@ release. Open the following URL in a browser:

.. parsed-literal::
https://github.com/orgs/dtcenter/projects?type=beta
https://github.com/orgs/dtcenter/projects
* Click on the project that corresponds to this release, i.e.
|projectRepo|-X.Y.Z-rcN

* Navigate to the "Closed Issues" tab.
**If this tab does not exist**, follow these instructions to create it:

* Click on "+ New view" button on the far right side of the view tabs
* Click on "View <N>" (where <N> is an integer) and rename it to
"Closed Issues"
* Click on the down arrow next to the newly created view
* Click on "Search or filter this view"
* Enter the following info into the filter bar: **is:closed is:issue**
* Click on the down arrow next to the view and click "Save changes"
|projectRepo|-X.Y.Z Development

* Navigate to the "Closed Issues" tab. If this tab does not exist,
see :ref:`wo-development-project` to create it.

* Update the release-notes.rst file found in the User's Guide directory.

Expand Down

0 comments on commit a37ffda

Please sign in to comment.