Skip to content

Commit 69f51fa

Browse files
james-bruten-mojames-bruten-mo
authored
final release sections (#406)
1 parent 5100592 commit 69f51fa

File tree

4 files changed

+143
-8
lines changed

4 files changed

+143
-8
lines changed

‎source/Reviewers/curaterelease.rst‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ Curating a Release
1212
releases/mule_release
1313
releases/um_main_release
1414
releases/lfric_apps_release
15+
releases/release_notes
16+
releases/stash_browser
17+
releases/umdp_release
1518
releases/updating_prebuilds
1619

1720
.. _reference-tagging:
@@ -61,9 +64,8 @@ Open a UM X.Y release Curation Ticket, and assign tasks as a team,
6164
||||||'''Post Release'''||
6265
|| || Release notes || ||
6366
|| || Update standard suites & finalise std jobs page || ||
64-
|| || Update $UMDIR scripts || ||
6567
|| || Check resource monitoring scripts still work || ||
66-
|| || Install Code and Stash browsers || ||
68+
|| || Install the Stash Browser || ||
6769
|| || UMDP3 Release || ||
6870
|| || Update wikis, working practices, and create bit comp table || ||
6971
|| || Review and update trunk and shared account permissions || ||
@@ -136,8 +138,8 @@ All LFRic Tickets (Apps + Core), Jules Release
136138
Post Release Tasks
137139
------------------
138140

139-
`Release Notes <https://code.metoffice.gov.uk/trac/um/wiki/CuratingARelease#ReleaseNotes>`_
140-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
141+
`Release Notes <release_notes>`
142+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
141143

142144
**Dependencies**
143145
Most of this can be done pre-release but some details of revision numbers will be dependent on the main release being done.
@@ -157,15 +159,15 @@ UM Release (for UM suites), Apps Release (for Apps suites)
157159
UM Release
158160

159161

160-
`Code and Stash Browsers <https://code.metoffice.gov.uk/trac/um/wiki/CuratingARelease#InstallCodeandStashbrowsers>`_
161-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
162+
`Stash Browser <stash_browser>`
163+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
162164

163165
**Dependencies**
164166
UM Release
165167

166168

167-
`UMDP Release <https://code.metoffice.gov.uk/trac/um/wiki/CuratingARelease#UMDPrelease>`_
168-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
169+
`UMDP Release <umdp_release>`
170+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
169171

170172
**Dependencies**
171173
UM Release, Standard Suites Upgrade

‎source/Reviewers/releases/release_notes.rst‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
.. _release_notes:
2+
3+
Release Notes
4+
=============
5+
6+
The below shows the trac release notes template previously used. This will want editing and the exact location needs deciding for the move to github. However it can be used as an initial guide to the sort of information included.
7+
8+
.. code-block::
9+
10+
[[PageOutline]]
11+
-----
12+
= UM vnXX.Y User Release Notes =
13+
14+
== Summary ==
15+
16+
* Release date:
17+
* Number of tickets:
18+
19+
=== Science highlights ===
20+
21+
=== Technical highlights ===
22+
23+
=== Optimisation highlights ===
24+
25+
== Known Issues ==
26+
27+
None
28+
29+
== Revisions and Keywords ==
30+
31+
|| Repository || !Keyword/Revision ||
32+
|| [browser:main UM] || vnXX.Y = NNNN ||
33+
|| [https://code.metoffice.gov.uk/trac/jules/browser/main JULES] || vnA.B = umXX.y = NNNN ||
34+
|| [https://code.metoffice.gov.uk/trac/monc/browser/casim CASIM] || etc ||
35+
|| [https://code.metoffice.gov.uk/trac/socrates/browser/main SOCRATES] || ||
36+
|| [https://code.metoffice.gov.uk/trac/ukca/browser/main UKCA] || ||
37+
|| [browser:aux Aux] || ||
38+
39+
GCOM and SHUMlib installations should be built using revisions:
40+
41+
|| Repository || !Keyword/Revision ||
42+
|| [https://code.metoffice.gov.uk/trac/gcom/browser/main GCOM] || vnXX.Y = NNNN ||
43+
|| [https://code.metoffice.gov.uk/trac/utils/browser/shumlib SHUMlib] || YYYY.MM.N = NNNN ||
44+
45+
Note that SHUMlib may not be released at every UM release.
46+
47+
For testing purposes, the LFRic Apps and MOCI repositories:
48+
49+
|| Repository || Revision ||
50+
|| [browser:main/trunk/rose-stem/rose-suite.conf MOCI] || NNNN ||
51+
|| [https://code.metoffice.gov.uk/trac/lfric_apps/browser/main LFRic Apps] || vnA.B = umXX.Y = NNNN ||
52+
53+
Required for rose-stem:
54+
55+
{{{#!comment
56+
Obtain these by grepping, for example:
57+
grep -r CYLC_VERSION ~frzz/cylc-run/um_heads_nightly_YYYY-MM-DD/log/job
58+
}}}
59+
60+
* Rose vn YYYY.MM.N
61+
* Cylc vn YYYY.MM.N
62+
63+
== Ticket Overview ==
64+
65+
* Tickets marked as closed/fixed below may not be associated with a [log:main/trunk trunk commit]
66+
* Only tickets with a UM element are displayed below. Sub-repositories may contain additional standalone tickets that will have been implicitly tested and included in the release.
67+
68+
[[TicketQuery(milestone^=UMXX.Y (MMM-YY),status=closed,resolution=fixed,format=table,col=summary|reporter|keywords)]]
69+
70+
== Platforms ==
71+
72+
Testing:
73+
* Met Office SPICE: [wiki:ReleaseNotesXX.Y/ReleaseTestingAZSPICE]
74+
* Met Office EX1A: [wiki:ReleaseNotesXX.Y/ReleaseTestingEX1A]
75+
76+
77+
For the highlights section:
78+
79+
* Contact HPC Optimisation team (usually AM) to request details for the optimisation section
80+
* Take some time to think about the 'big picture' relevance of tickets for the science and technical highlights
81+
* Copy the 'head of trunk' section and paste underneath, changing the section title to the release.
82+
* Paste trac.logs into the relevant sub-pages. You'll likely be able to use some nightly testing runs.

‎source/Reviewers/releases/stash_browser.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. _stash_browser:
2+
3+
Stash Browser
4+
=============
5+
6+
* Checkout a copy of the UM at release, ``fcm co fcm:um.xm_tr@vnXX.Y``. Move into the top directory and run,
7+
8+
.. code-block::
9+
10+
./admin/stashbrowser/stashweb -i rose-meta/um-atmos/HEAD/etc/stash/STASHmaster/STASHmaster_A -o UMXXY_STASHweb
11+
12+
substituting for ``XXY``.
13+
* Login as the UM shared account
14+
* Copy the ``UMXXY_STASHweb`` directory created earlier to ``$UMDIR/public_html/frozen/XX.Y/stash_browse``
15+
* Check everything looks right at https://wwwspice/~umadmin/stashtech.html
16+
17+

‎source/Reviewers/releases/umdp_release.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. _umdp_release:
2+
3+
UMDP Release
4+
============
5+
6+
* Create a ticket and a Head of Trunk branch of the UM documentation.
7+
* You will need to update a few files:
8+
9+
* For ``web/js/um-version.js`` update the version number, release name, and standard suite revision numbers.
10+
* For ``template/UMDP.cls``, update the version number.
11+
* For the x-series documentation, you will at minimum need to check and update:
12+
13+
* ``source/X04/X4-fcm.tex`` Revision number and version number
14+
* ``source/X04/X4-prerequisites.tex`` rose and cylc versions (found in the release notes).
15+
* ``source/X04/X4.tex`` UM, gcom, shumlib and UKCA versions (found in the release notes).
16+
* ``source/X06/X6.tex`` UM version number.
17+
* ``source/X10/X10.tex`` UM, JULES and UKCA version numbers, gcom branch URL.
18+
19+
* It is also worth checking no URLs are out of date.
20+
* Get ticket reviewed and committed.
21+
* :ref:`Tag <reference-tagging>` the documentation trunk by adding the correct ``vnXX.X`` keyword.
22+
* To Publish the docs:
23+
24+
* Get a new copy of the head of the docs trunk
25+
* From the top level, run ``build_umdoc.py all`` to build everything
26+
* Remove the output logs in ``output/log/*`` - just to save a bit of space.
27+
* Checkout a copy of the published documentation - just take the UM part of it as the whole thing is massive! i.e. ``fcm co https://code.metoffice.gov.uk/svn/doc/um published_um``
28+
* We keep the 3 most recent UM versions so delete one, ``fcm del vnXX.Y-2``
29+
* Edit the ``index.html`` file to remove the oldest version and add a new line for the new one.
30+
* Copy the ``output`` directory that was created by the build script earlier into a ``vnXX.Y`` directory and make sure it is added to the version control.
31+
* Finally, update the ``latest`` symlink to point to the newest version, ``ln -s vnXX.Y latest``
32+
* Finally, commit the changes and check the output at https://code.metoffice.gov.uk/doc/
33+
34+

0 commit comments

Comments
 (0)