Skip to content

Commit a8aba7b

Browse files
update um release instructions (#531)
Co-authored-by: Jenny Hickson <61183013+jennyhickson@users.noreply.github.com>
1 parent 7569ff6 commit a8aba7b

File tree

1 file changed

+33
-35
lines changed

1 file changed

+33
-35
lines changed

source/Reviewers/releases/um_main_release.rst

Lines changed: 33 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,6 @@ Also update the ``ref`` for Mule and SHUMLIB to point to their latest releases.
4242

4343
Commit this change to the branch.
4444

45-
Apply Code Styling
46-
------------------
47-
48-
* Switch to the UM branch
49-
* Set ``export RUNFULL=1`` then run ./admin/code_styling/apply_styling
50-
* If any files have changed, check nothing has gone wrong with a quick compile
51-
``cylc vip -z g=fcm_make_ex1a_gnu_um_rigorous_omp -n um_release_style_check
52-
./rose-stem``
53-
* Commit any changes
54-
5545

5646
Checking Metadata and Rose Apps
5747
-------------------------------
@@ -117,16 +107,21 @@ Copying the metadata and upgrade macros to the um_meta branch
117107

118108
The next step is to move the macros and metadata into the meta branch. The
119109
metadata will have been created already by the release script. For each of the
120-
``um-atmos``, ``um-fcm-make`` and ``um-createbc`` metadata sections, move the
121-
new ``vnX.Y`` directory into the ``um_meta`` clone, eg.
110+
``um-atmos``, ``um-fcm-make`` and ``um-createbc`` metadata sections (there is
111+
no need to edit the um-crmstyle metadata), move the new ``vnX.Y`` directory
112+
into the ``um_meta`` clone, eg.
122113

123114
.. code-block:: shell
124115
125116
mv rose-meta/um-atmos/vnX.Y /path/to/meta_clone/um-atmos/
117+
mv rose-meta/um-atmos/versionsXXX_YYY.py /path/to/meta_clone/um-atmos/
126118
cd /path/to/meta_clone
127119
git add um-atmos/vnX.Y
128120
129-
Note, there is no need to move um-crmstyle as it only contains HEAD metadata.
121+
.. important::
122+
123+
Make sure that those moved files/directories have not been added to the
124+
version control in the UM branch. Use ``git rm`` if so.
130125

131126
In the ``um_meta`` clone, manually add a line to each of the
132127
``um-atmos/versions.py``, ``um-fcm-make/versions.py`` and
@@ -141,9 +136,9 @@ Final Checks
141136

142137
**UM AUX Changes**
143138

144-
If there are changes to the AUX ``main`` in this release, then add a new tag to the
145-
``um_aux`` repository and then update the ``ref`` in the UM
146-
``dependencies.yaml`` file - commit this to the branch.
139+
If there are changes to the AUX ``main`` in this release, then add a new
140+
``YYYY.MM.N`` tag to the ``um_aux`` repository and then update the ``ref`` in
141+
the UM ``dependencies.yaml`` file - commit this to the branch.
147142

148143
**Other Points**
149144

@@ -155,8 +150,9 @@ If there are changes to the AUX ``main`` in this release, then add a new tag to
155150
* Does the minimum version of Rose/Cylc need to be increased? (Do any
156151
rose-ana changes require new functionality?)
157152
* Do any of the apps or parts of the suites reference ``$UMDIR`` - they
158-
shouldn't (the correct thing to do is to reference
159-
``$UM_INSTALL_DIR``).
153+
shouldn't (other than for ancil paths). The correct thing to do is to
154+
reference ``$UM_INSTALL_DIR`` - if there are $UMDIR references this will
155+
likely fail testing later.
160156

161157
* ``grep`` for any instances of the old version number. Fix as required and
162158
add any corrections to the instructions on this page too.
@@ -169,8 +165,8 @@ Preparing to Test
169165

170166
.. important::
171167

172-
When referring to **all** platforms below, this means Azure Spice, EXAB, EXCD, EXZ
173-
168+
When referring to **all** platforms below, this means Azure Spice, EXAB,
169+
EXCD, EXZ
174170

175171
* Check that a ``$UMDIR/standard_jobs/inputs/vnX.Y`` input data directory
176172
exists in UMDIR on **all** platforms - this should have been done as part of
@@ -268,11 +264,15 @@ navigate to ``$UMDIR/SimSys_Scripts/kgo_updates`` directory and run
268264

269265
.. important::
270266

271-
The authentication for running as the shared user via ``sudo`` will likely
272-
have expired before each of the 2 rsync commands, so pay attention as the
273-
script nears these points. If you forget and the command times out, the
274-
command can be launched manually from the command line. Ask the team if
275-
for help if required.
267+
* The authentication for running as the shared user via ``sudo`` will likely
268+
have expired before each of the 2 rsync commands, so pay attention as the
269+
script nears these points. If you forget and the command times out, the
270+
command can be launched manually from the command line. Ask the team if
271+
for help if required.
272+
273+
* Once the rsync to the first platform has begun, you can continue with the
274+
steps below. There is no need to wait until the rsyncs have fully finished
275+
as this takes quite some time.
276276

277277
Once you believe you have installed the KGO you should revert the changes
278278
you made to the variables*.cylc files to reset the KGO variables, ``git restore
@@ -290,7 +290,8 @@ The test suite should now be rerun to confirm the kgo has been installed
290290
properly. As we can't restart Cylc8 rose-stem suites, the entire thing needs
291291
to be rerun. We're just checking that the kgo has been installed, so it's
292292
probably unnecessary to wait for the entire thing - instead just ensure a
293-
reasonable range of rose-ana tasks have passed.
293+
reasonable range of rose-ana tasks have passed. Make sure to target the same EX
294+
host zone as above.
294295

295296

296297
Review and Commit
@@ -321,28 +322,28 @@ appear in the correct place. Do this by running,
321322

322323
.. code-block:: shell
323324
324-
cylc vip -z g=install -S CENTRAL_INSTALL=false -S USE_EXAB=true -z umx.y_install ./rose-stem
325+
cylc vip -z g=install -S CENTRAL_INSTALL=false -S USE_EXAB=true -n umx.y_install ./rose-stem
325326
326-
and check that ``~umadmin/cylc_run/<working_copy_name>/runN/share/vnX.Y``
327+
and check that ``~umadmin/cylc_run/umx.y_install/runN/share/vnX.Y``
327328
exists and is the new version number. If that has worked, change the
328329
CENTRALL_INSTALL flag to true and rerun,
329330

330331
.. code-block:: shell
331332
332-
cylc vip -z g=install -S CENTRAL_INSTALL=true -S USE_EXAB=true -z umx.y_install ./rose-stem
333+
cylc vip -z g=install -S CENTRAL_INSTALL=true -S USE_EXAB=true -n umx.y_install ./rose-stem
333334
334335
335336
Next, rerun the install for the 2nd host zone,
336337

337338
.. code-block:: shell
338339
339-
cylc vip -z g=ex1a_install -S CENTRAL_INSTALL=true -S USE_EXCD=true -z umx.y_install ./rose-stem
340+
cylc vip -z g=ex1a_install -S CENTRAL_INSTALL=true -S USE_EXCD=true -n umx.y_install ./rose-stem
340341
341342
Finally, rerun the install for the EXZ,
342343

343344
.. code-block:: shell
344345
345-
cylc vip -z g=ex1a_install -S CENTRAL_INSTALL=true -S USE_EXZ=true -z umx.y_install ./rose-stem
346+
cylc vip -z g=ex1a_install -S CENTRAL_INSTALL=true -S USE_EXZ=true -n umx.y_install ./rose-stem
346347
347348
The release is now installed and can be announced.
348349

@@ -379,10 +380,7 @@ Now run the central install group,
379380

380381
.. code-block:: shell
381382
382-
cylc vip -z g=ex1a_install -S CENTRAL_INSTALL=true -z umx.y_install ./rose-stem
383-
384-
Install prebuilds on Monsoon. Note the ``--no-run-name`` is required to force
385-
the install location to be consistent with other platforms.
383+
cylc vip -z g=ex1a_install -S CENTRAL_INSTALL=true -n umx.y_install ./rose-stem
386384
387385
Finally we need to install the kgo for the release. Do this by running the
388386
``ex1a`` group. Once that is finished, run the kgo install script(sourced from

0 commit comments

Comments
 (0)