Skip to content

Commit da2f874

Browse files
committed
update release instructions
1 parent 40436b1 commit da2f874

3 files changed

Lines changed: 84 additions & 0 deletions

File tree

source/Reviewers/curaterelease.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,31 @@ Curating a Release
2323
releases/standard_suites
2424
releases/stash_browser
2525
releases/umdp_release
26+
releases/milestones
2627
releases/wiki_pages
2728
releases/shared_accounts
2829
releases/updating_prebuilds
2930

3031
.. _reference-tagging:
3132

33+
Code Review Deadline
34+
--------------------
35+
36+
In the weeks leading up to the deadline, announcements should be made on the
37+
`Simulation Systems Discussion Board <https://github.com/MetOffice/simulation-systems/discussions>`_
38+
to remind the community of the upcoming deadline.
39+
40+
Shortly after the deadline Issues that are not in review should be removed
41+
from the milestone. This is done here to give the assignees time to assess their
42+
work before the release happens.
43+
44+
.. code-block::
45+
46+
python SimSys_Scripts/gh_review/project/cr_deadline.py --milestone=<title>
47+
48+
with an optional argument ``--dry`` to dry run the changes before doing them
49+
for real.
50+
3251
Release Issue
3352
-------------
3453

@@ -259,6 +278,13 @@ UM Release
259278
UM Release, Standard Suites Upgrade
260279

261280

281+
:ref:`Milestones and Projects <milestones>`
282+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
283+
284+
**Dependencies**
285+
All Releases
286+
287+
262288
:ref:`Standard Jobs and Wiki Pages <wiki_pages>`
263289
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
264290

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
.. -----------------------------------------------------------------------------
2+
(c) Crown copyright Met Office. All rights reserved.
3+
The file LICENCE, distributed with this code, contains details of the terms
4+
under which the code may be used.
5+
-----------------------------------------------------------------------------
6+
7+
.. _milestones:
8+
9+
Milestones and Projects
10+
=======================
11+
12+
#. Tidy up all pull requests and issues for the completed milestone in the
13+
Simulation Systems Review and Issues Trackers.
14+
15+
.. code-block:: shell
16+
17+
python SimSys_Scripts/gh_review_project/finish_milestone.py --milestone="<milestone title>"
18+
19+
with optional argument ``--dry`` to dry run the changes.
20+
21+
The script will prompt for you to continue after checking all PRs and issues
22+
are in a suitable state. If it flags items that need correcting then go to
23+
`Simulation Systems Review Tracker`_ and
24+
`Simulation Systems Issue Tracker`_ to manually sort them.
25+
26+
#. As prompted by the above script, close the current milestone using:
27+
28+
.. code-block:: shell
29+
30+
./SimSys_Scripts/sbin/gh_manage_milestones -t <title of milestone> -m close
31+
32+
#. Open the next new milestone so that there are the same number of open milestones:
33+
34+
.. code-block:: shell
35+
36+
./SimSyS_Scripts/sbin/gh_manage_milestones -t <title> -d YYYY-MM-DDTHH:MM:SSZ -p <description>
37+
38+
* the title is ``Spring YYYY``, ``Summer YYYY`` or ``Autumn YYYY``
39+
* the date is the first Wednesday in March, July or November
40+
* the description is ``Code Review deadline is <date> (SciTech review to be completed by this date)``
41+
selecting a Friday at the end of January/May/September for the deadline.
42+
43+
.. _Simulation Systems Review Tracker: https://github.com/orgs/MetOffice/projects/376
44+
.. _Simulation Systems Issue Tracker: https://github.com/orgs/MetOffice/projects/418

source/WorkingPractices/gh_dev_init.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,20 @@ To create a branch and switch to it from the command line, the syntax is,
192192
git branch <branch_name> <start_point>
193193
git switch <branch_name>
194194
195+
.. tip::
196+
197+
When cloning a repository only the default branch, ``main``, is
198+
included in your local environment. To use ``stable`` as your
199+
start_point for a branch then running
200+
201+
``git switch stable``
202+
203+
will clone the stable branch, and it will then be available for
204+
future branch creation.
205+
206+
Alternatively you can use ``origin/stable`` as your start_point
207+
which reads directly from the remote copy of your fork.
208+
195209
.. tip::
196210

197211
If you're creating a branch to use to

0 commit comments

Comments
 (0)