Repository navigation
Expand file tree
/
Copy pathReleaseChecklist.html
More file actions
1155 lines (1011 loc) · 75.8 KB
/
Copy pathReleaseChecklist.html
File metadata and controls
1155 lines (1011 loc) · 75.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Release Checklist — MantidProject main documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=18bd87630a240e9c25be" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=18bd87630a240e9c25be" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/css/style.css?v=562d7d41" />
<!-- So that users can add custom icons -->
<script defer src="_static/scripts/fontawesome.js?digest=18bd87630a240e9c25be"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=18bd87630a240e9c25be" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=18bd87630a240e9c25be" />
<script src="_static/documentation_options.js?v=a8da1a53"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'ReleaseChecklist';</script>
<script>DOCUMENTATION_OPTIONS.search_as_you_type = false;</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Patch Release Checklist" href="PatchReleaseChecklist.html" />
<link rel="prev" title="Jenkins Configuration" href="JenkinsConfiguration.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
<link rel="icon" sizes="32x32" href="_static/images/favicon.ico">
</head>
<body data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header id="pst-header" class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button type="button" class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/images/mantid_logo_light.png" class="logo__image only-light" alt="Logo image">
<img src="_static/images/mantid_logo_dark.png" class="logo__image only-dark" alt="Logo image">
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="https://download.mantidproject.org">Downloads</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/nightly/tutorials/">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org">User Docs</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://developer.mantidproject.org">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/release/">Release notes</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://www.mantidproject.org/contact">Contact Us</a>
</li>
</ul></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button type="button" class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item">
<div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode">
<button type="button" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown">
<i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i>
</button>
<ul class="dropdown-menu dropdown-menu-end">
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li>
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li>
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li>
</ul>
</div></div>
<div class="navbar-item"><ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a class="nav-link" href="https://github.com/mantidproject/mantid" rel="noopener" target="_blank" title="GitHub">
<span><i class="fab fa-github-square"></i></span>
<label class="sr-only">GitHub</label>
</a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button type="button" class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<button type="button" class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="https://download.mantidproject.org">Downloads</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/nightly/tutorials/">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org">User Docs</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://developer.mantidproject.org">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://docs.mantidproject.org/release/">Release notes</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="https://www.mantidproject.org/contact">Contact Us</a>
</li>
</ul></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode">
<button type="button" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown">
<i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i>
</button>
<ul class="dropdown-menu dropdown-menu-end">
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li>
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li>
<li><button type="button" class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li>
</ul>
</div></div>
<div class="navbar-item"><ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a class="nav-link" href="https://github.com/mantidproject/mantid" rel="noopener" target="_blank" title="GitHub">
<span><i class="fab fa-github-square"></i></span>
<label class="sr-only">GitHub</label>
</a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item pst-sidebar-collapse"><button type="button" id="pst-collapse-sidebar-button" aria-expanded="true" aria-controls="pst-primary-sidebar">
<svg class="pst-icon" role="img" aria-hidden="true" focusable="false" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg">
<path fill="currentColor" d="M3 15.5C2.36232 15.5 1.74874 15.2564 1.28478 14.8189C0.820828 14.3815 0.541576 13.7832 0.504167 13.1467L0.5 13L0.5 3C0.499965 2.36232 0.743605 1.74874 1.18107 1.28478C1.61854 0.820828 2.21676 0.541576 2.85333 0.504167L3 0.5L13 0.5C13.6377 0.499965 14.2513 0.743605 14.7152 1.18107C15.1792 1.61854 15.4584 2.21676 15.4958 2.85333L15.5 3L15.5 13C15.5 13.6377 15.2564 14.2513 14.8189 14.7152C14.3815 15.1792 13.7832 15.4584 13.1467 15.4958L13 15.5L3 15.5ZM3 13.8333L10.5 13.8333L10.5 2.16667L3 2.16667C2.79589 2.16669 2.59889 2.24163 2.44636 2.37726C2.29383 2.5129 2.19638 2.69979 2.1725 2.9025L2.16667 3L2.16667 13C2.16669 13.2041 2.24163 13.4011 2.37726 13.5536C2.5129 13.7062 2.69979 13.8036 2.9025 13.8275L3 13.8333ZM6.65583 10.325L6.5775 10.2558L4.91083 8.58917C4.76735 8.44567 4.68116 8.25476 4.66843 8.05223C4.65569 7.84971 4.71729 7.6495 4.84167 7.48917L4.91083 7.41083L6.5775 5.74417C6.72747 5.59471 6.9287 5.50794 7.14032 5.50148C7.35194 5.49502 7.55809 5.56935 7.7169 5.70937C7.8757 5.8494 7.97525 6.04463 7.99533 6.25539C8.01541 6.46616 7.95451 6.67667 7.825 6.84417L7.75583 6.9225L6.67917 8L7.75583 9.0775C7.89931 9.22099 7.98551 9.41191 7.99824 9.61443C8.01097 9.81695 7.94938 10.0172 7.825 10.1775L7.75583 10.2558C7.61234 10.3993 7.42142 10.4855 7.2189 10.4982C7.01638 10.511 6.81617 10.4494 6.65583 10.325Z"/>
</svg>
<span class="pst-collapse-sidebar-label">Collapse Sidebar</span>
<span class="pst-expand-sidebar-label">Expand Sidebar</span>
</button></div>
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"></div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Release Checklist</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="release-checklist">
<span id="releasechecklist"></span><h1>Release Checklist<a class="headerlink" href="#release-checklist" title="Link to this heading">#</a></h1>
<p>These are the steps involved in performing a full Mantid release. To
request or perform a patch release look at the
<a class="reference internal" href="PatchReleaseChecklist.html#patchreleasechecklist"><span class="std std-ref">patch release checklist</span></a>.</p>
<section id="roles">
<h2>Roles<a class="headerlink" href="#roles" title="Link to this heading">#</a></h2>
<p>The roles are defined in terms of the people responsible.
Those in the role do not need to carry out all duties themselves, but they
are responsible for ensuring that the work gets done.</p>
<ul class="simple">
<li><p><a class="reference internal" href="#local-project-managers-checklist"><span class="std std-ref">Local Project Manager(s)</span></a> - People in charge
of communicating with local development teams, facility management, and other people
at their sponsoring facility.</p></li>
<li><p><a class="reference internal" href="#quality-assurance-manager-checklist"><span class="std std-ref">Quality Assurance Manager</span></a> - People responsible
for making sure that manual testing has been performed. They will ensure Mantid meets
quality requirements before delivery in consultation with the <em>Release Manager</em>.</p></li>
<li><p><a class="reference internal" href="#release-editor-checklist"><span class="std std-ref">Release Editor</span></a> - People responsible for ensuring the
release notes are edited to give them a common language, layout, and illustrative images.</p></li>
<li><p><a class="reference internal" href="#release-manager-checklist"><span class="std std-ref">Release Manager</span></a> - Person in charge of the go/no go
decision of the release. The main task is to reiterate the timeline and be the collection
point for information between all of the <em>Local Project Managers</em>.</p></li>
<li><p><a class="reference internal" href="#technical-release-manager-checklist"><span class="std std-ref">Technical Release Manager</span></a> - People responsible
for technical tasks such as renaming branches, creating tags, configuring build servers, and
ensuring problems on the Release Pipeline get fixed (by themselves or others).</p></li>
</ul>
</section>
<section id="timeline">
<h2>Timeline<a class="headerlink" href="#timeline" title="Link to this heading">#</a></h2>
<p>This is final part of the <a class="reference internal" href="DevelopmentAndReleaseCycle.html#developmentandreleasecycle"><span class="std std-ref">development and release cycle</span></a>.</p>
<div class="pst-scrollable-table-container"><table class="table">
<thead>
<tr class="row-odd"><th class="head"><div class="line-block">
<div class="line">Key Event(s)</div>
</div>
</th>
<th class="head"><div class="line-block">
<div class="line">Task Priorities</div>
</div>
</th>
<th class="head"><div class="line-block">
<div class="line">Actions Required from</div>
</div>
</th>
<th class="head"><div class="line-block">
<div class="line">Time Until Release</div>
</div>
</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>2-3 weeks before Feature
Freeze</p></td>
<td><p>Development, Testing & Documentation</p></td>
<td><div class="line-block">
<div class="line"><a class="reference internal" href="#release-manager-checklist"><span class="std std-ref">Release Manager</span></a></div>
</div>
</td>
<td><p>4-6+ weeks</p></td>
</tr>
<tr class="row-odd"><td><div class="line-block">
<div class="line">1 week before Feature</div>
<div class="line">Freeze</div>
</div>
</td>
<td><p>Development, Testing & Documentation</p></td>
<td><div class="line-block">
<div class="line"><a class="reference internal" href="#local-project-managers-checklist"><span class="std std-ref">Local Project Manager(s)</span></a></div>
<div class="line"><a class="reference internal" href="#release-manager-checklist"><span class="std std-ref">Release Manager</span></a></div>
</div>
</td>
<td><p>4+ weeks</p></td>
</tr>
<tr class="row-even"><td><p><strong>Feature Freeze Begins</strong></p></td>
<td><p>Final Development, Testing & Documentation</p></td>
<td><div class="line-block">
<div class="line"><a class="reference internal" href="#local-project-managers-checklist"><span class="std std-ref">Local Project Manager(s)</span></a></div>
<div class="line"><a class="reference internal" href="#release-manager-checklist"><span class="std std-ref">Release Manager</span></a></div>
<div class="line"><a class="reference internal" href="#technical-release-manager-checklist"><span class="std std-ref">Technical Release Manager</span></a></div>
</div>
</td>
<td><p>3 weeks + 1 working day</p></td>
</tr>
<tr class="row-odd"><td><p><strong>Manual Testing</strong></p></td>
<td><p>Blocker bug fixes, Testing & Release Notes</p></td>
<td><div class="line-block">
<div class="line"><a class="reference internal" href="#quality-assurance-manager-checklist"><span class="std std-ref">Quality Assurance Manager</span></a></div>
<div class="line"><a class="reference internal" href="#release-manager-checklist"><span class="std std-ref">Release Manager</span></a></div>
</div>
</td>
<td><p>3 weeks</p></td>
</tr>
<tr class="row-even"><td><p><strong>Beta Testing Begins</strong></p></td>
<td><p>Blocker bug fixes, Testing, Release Notes,
Maintenance Tasks & Next release development</p></td>
<td><div class="line-block">
<div class="line"><a class="reference internal" href="#local-project-managers-checklist"><span class="std std-ref">Local Project Manager(s)</span></a></div>
<div class="line"><a class="reference internal" href="#release-editor-checklist"><span class="std std-ref">Release Editor</span></a></div>
<div class="line"><a class="reference internal" href="#release-manager-checklist"><span class="std std-ref">Release Manager</span></a></div>
</div>
</td>
<td><p>2.5 weeks</p></td>
</tr>
<tr class="row-odd"><td><p>Reminder Email for Beta</p></td>
<td><p>Blocker bug fixes, Testing, Release Notes,
Maintenance Tasks & Next release development</p></td>
<td><div class="line-block">
<div class="line"><a class="reference internal" href="#release-manager-checklist"><span class="std std-ref">Release Manager</span></a></div>
</div>
</td>
<td><p>1.5 weeks</p></td>
</tr>
<tr class="row-even"><td><p><strong>Beta Testing Ends</strong></p></td>
<td><p>Blocker bug fixes, Testing, Release Notes,
Maintenance Tasks & Next release development</p></td>
<td><div class="line-block">
<div class="line"><a class="reference internal" href="#release-editor-checklist"><span class="std std-ref">Release Editor</span></a></div>
<div class="line"><a class="reference internal" href="#release-manager-checklist"><span class="std std-ref">Release Manager</span></a></div>
<div class="line"><a class="reference internal" href="#quality-assurance-manager-checklist"><span class="std std-ref">Quality Assurance Manager</span></a></div>
</div>
</td>
<td><p>~ 4 working days</p></td>
</tr>
<tr class="row-odd"><td><p><strong>Smoke Testing</strong></p></td>
<td><p>Blocker bug fixes, Testing & Packaging</p></td>
<td><div class="line-block">
<div class="line"><a class="reference internal" href="#quality-assurance-manager-checklist"><span class="std std-ref">Quality Assurance Manager</span></a></div>
<div class="line"><a class="reference internal" href="#release-manager-checklist"><span class="std std-ref">Release Manager</span></a></div>
<div class="line"><a class="reference internal" href="#technical-release-manager-checklist"><span class="std std-ref">Technical Release Manager</span></a></div>
</div>
</td>
<td><p>1 working day</p></td>
</tr>
<tr class="row-even"><td><p><strong>Release Day</strong></p></td>
<td><p>Blocker bug fixes, Testing & Release
Announcements</p></td>
<td><div class="line-block">
<div class="line"><a class="reference internal" href="#release-manager-checklist"><span class="std std-ref">Release Manager</span></a></div>
<div class="line"><a class="reference internal" href="#technical-release-manager-checklist"><span class="std std-ref">Technical Release Manager</span></a></div>
</div>
</td>
<td><p>0</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="local-project-managers-checklist">
<span id="id1"></span><h2>Local Project Managers Checklist<a class="headerlink" href="#local-project-managers-checklist" title="Link to this heading">#</a></h2>
<p><strong>Role</strong>: People in charge of communicating with local development teams, facility
management, and other people at their sponsoring facility.</p>
<section id="week-before-code-freeze">
<h3>1 week before Code Freeze<a class="headerlink" href="#week-before-code-freeze" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Before the code freeze is in place the PM and Technical Steering Committee (TSC)
need to agree the maintenance tasks for the next release period.</p></li>
</ul>
</section>
<section id="code-freeze">
<h3>Code Freeze<a class="headerlink" href="#code-freeze" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Attempt to drive the pull requests for this milestone down to 0, in collaboration
with the Release Manager.</p></li>
</ul>
</section>
<section id="beta-testing-begins">
<h3>Beta Testing Begins<a class="headerlink" href="#beta-testing-begins" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Ensure that developers arrange to meet with their beta testers.</p></li>
<li><p>Triage when necessary the issues discovered during beta testing.</p></li>
</ul>
</section>
</section>
<section id="quality-assurance-managers-checklist">
<span id="quality-assurance-manager-checklist"></span><h2>Quality Assurance Managers Checklist<a class="headerlink" href="#quality-assurance-managers-checklist" title="Link to this heading">#</a></h2>
<p><strong>Role</strong>: People responsible for making sure that manual testing has been performed.
They will ensure Mantid meets quality requirements before delivery in consultation
with the Release Manager.</p>
<section id="manual-testing">
<h3>Manual Testing<a class="headerlink" href="#manual-testing" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Ensure that Manual testing begins by creating the testing tasks as GitHub issues, assigning them and posting on
Slack. Most of our Manual testing instructions are <a class="reference internal" href="Testing/index.html#testing"><span class="std std-ref">here</span></a>. Generate the Manual testing issues by
following the instructions in the
<a class="reference external" href="https://github.com/mantidproject/documents/tree/main/Project-Management/Tools/RoadmapUpdate">README file</a>.
Please raise the issues from the ISIS and Non-ISIS manual testing spreadsheets.</p></li>
<li><p>Over the next week, check the Manual testing GitHub issues. Testers should raise any
serious problems as separate GitHub issues with a relevant milestone. When testing tasks are complete and all serious
problems raised as issues, then the testing GitHub issue should be closed.</p></li>
<li><p>Manual testing at ISIS as of release 6.3, has taken the form of
<a class="reference external" href="https://github.com/mantidproject/documents/blob/main/Project-Management/Tools/RoadmapUpdate/Ensemble%20Manual%20Testing.pptx">Ensemble Manual Testing</a>.
In short, testing teams of around 3-5 developers, spread across sub-teams
are assigned tasks with the code expert in that testing team.</p></li>
<li><p>It is important to ensure that for each operating system, there is at least one person responsible for installing
the conda version and one person responsible for installing the non-conda version of Mantid.</p></li>
</ul>
</section>
<section id="beta-testing-ends-prepare-for-smoke-testing">
<h3>Beta Testing Ends - Prepare for Smoke Testing<a class="headerlink" href="#beta-testing-ends-prepare-for-smoke-testing" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Liaise with the technical release manager and project manager to decide on an appropriate time for Smoke Testing.</p></li>
<li><p>Send an invite to developers for 1.5 hours maximum Smoke Testing. Include an introduction message to assign all testers to a certain operating system.
Link to the release pipeline builds where the release packages <em>WILL</em> be. Encourage testers to download
in the 30 minutes before smoke testing. Inform that ticking on a testing issue means that someone has assigned themselves and will tackle that task.</p></li>
</ul>
</section>
<section id="smoke-testing">
<h3>Smoke Testing<a class="headerlink" href="#smoke-testing" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Make sure to follow the preparation steps listed above.</p></li>
<li><p>It is likely that many changes have been made over the beta test period, therefore
we must do some more manual testing to ensure everything still works. This stage is
called Smoke testing. Generate the Smoke testing issues by following the instructions
<a class="reference external" href="https://github.com/mantidproject/documents/tree/main/Project-Management/Tools/RoadmapUpdate/SmokeTesting">here</a>.</p></li>
<li><p>Liaise with the Technical Release Manager and together announce the creation of the
Smoke testing issues and Release Candidates in the <em>#general</em> slack channel.</p></li>
<li><p>During smoke testing it may be easier if at least one QA Manager acts as facilitator during the session. They will answer questions, co-ordinate testing
(especially when an arising issue needs testing on other OS) and ensure all testing is covered.</p></li>
</ul>
</section>
</section>
<section id="release-editors-checklist">
<span id="release-editor-checklist"></span><h2>Release Editors Checklist<a class="headerlink" href="#release-editors-checklist" title="Link to this heading">#</a></h2>
<p><strong>Role</strong>: People responsible for editing the release notes and giving them a common
language, layout, and collecting images.</p>
<section id="id2">
<h3>Beta Testing Begins<a class="headerlink" href="#id2" title="Link to this heading">#</a></h3>
<ul>
<li><p>Initial amalgamation of the release notes:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">pull</span></code> on <code class="docutils literal notranslate"><span class="pre">release-next</span></code>.</p></li>
<li><p>Create a new branch using the <a class="reference external" href="https://developer.mantidproject.org/GitWorkflow.html#new-branches">Mantid Git Workflow guidance</a>.</p></li>
<li><p>Navigate to your Mantid ‘build’ directory and open <code class="docutils literal notranslate"><span class="pre">command-prompt.bat</span></code>.</p></li>
<li><p>In the new command prompt, navigate to the <a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/tools/ReleaseNotes/release_editor.py">release_editor.py script</a> and run, parsing the correct version number. The script copies all of the separate release notes under the correct heading of their upper level file, e.g. <code class="docutils literal notranslate"><span class="pre">framework.rst</span></code>, and moves the original release notes into a ‘Used’ directory. The Git token is needed to query the git api for the pull request which added each release note.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>release_editor.py<span class="w"> </span>--release<span class="w"> </span><span class="m">6</span>.5.0<span class="w"> </span>--git_token<span class="w"> </span><your_git_token_here>
</pre></div>
</div>
</li>
<li><p>Check the script has run correctly by checking all individual rst files have been moved into their respective ‘used’ directories. You could use the <a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/tools/ReleaseNotes/unused_release_note_finder.py">unused_release_note_finder.py script</a> for this (explained further bellow).</p></li>
<li><p>Look over the files to make sure they look roughly correct then submit a PR to be merged into <code class="docutils literal notranslate"><span class="pre">release-next</span></code>.</p></li>
</ul>
</li>
<li><p>Initial changes:</p>
<ul class="simple">
<li><p>For each file which needs changes, create a new branch (example name <code class="docutils literal notranslate"><span class="pre">6.5_workbench_release_notes</span></code>) and work on changes to then be merged back into <code class="docutils literal notranslate"><span class="pre">release-next</span></code>.</p></li>
</ul>
</li>
<li><p>Incoming release notes:</p>
<ul>
<li><p>As the release sprint goes on, new release note files will be created (existing outside of the ‘Used’ directories). The text from these will need to be copped into the main release note pages (<code class="docutils literal notranslate"><span class="pre">diffraction.rst</span></code>, <code class="docutils literal notranslate"><span class="pre">mantidworkbench.rst</span></code> etc.) and the file itself moved to it’s corresponding ‘Used’ directory.</p></li>
<li><p>It is best to wait until several of these have built up before making a new branch / pr.</p></li>
<li><p>To help with finding the new release notes, use the <a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/tools/ReleaseNotes/unused_release_note_finder.py">unused_release_note_finder.py script</a> which will print the location of release notes not within a ‘Used’ directory.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>unused_release_note_finder.py<span class="w"> </span>--release<span class="w"> </span><span class="m">6</span>.5.0
</pre></div>
</div>
</li>
</ul>
</li>
<li><p>Images:</p>
<ul class="simple">
<li><p>Images or GIFs should be added to highlight important and/or visual changes.</p></li>
<li><p>An image for the ‘headline’ feature (or a collage if there is none) should be added to the main page (<code class="docutils literal notranslate"><span class="pre">index.rst</span></code>).</p></li>
</ul>
</li>
</ul>
</section>
<section id="beta-testing-ends">
<h3>Beta Testing Ends<a class="headerlink" href="#beta-testing-ends" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Review the complete set of release notes to make sure there are no glaring mistakes.</p></li>
</ul>
</section>
<section id="just-before-release">
<h3>Just before release<a class="headerlink" href="#just-before-release" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>As one of the final steps in preparing to tag the release:</p>
<ul>
<li><p>Check for uncollected release notes using the <a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/tools/ReleaseNotes/unused_release_note_finder.py">unused_release_note_finder.py script</a>.</p></li>
<li><p>Check <code class="docutils literal notranslate"><span class="pre">main</span></code> for any release notes that have been merged into the wrong branch.</p></li>
<li><p>Remove any unused headings which have not already been removed from the release notes.</p></li>
<li><p>Remove all the “Used” release note files and their sub-structure.</p></li>
</ul>
</li>
</ul>
</section>
</section>
<section id="release-manager-checklist">
<span id="id3"></span><h2>Release Manager Checklist<a class="headerlink" href="#release-manager-checklist" title="Link to this heading">#</a></h2>
<p><strong>Role</strong>: Person in charge of the go/no go decision of the release. The main task
is to reiterate the timeline and be the collection point for information between
all of the Local Project Managers.</p>
<section id="weeks-before-feature-freeze">
<h3>2-3 weeks before Feature Freeze<a class="headerlink" href="#weeks-before-feature-freeze" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Schedule a release showcase meeting for all facilities to present work that
is intended to be part of the upcoming release.
This meeting should aim to be in the week leading up to the feature freeze
and include a timeline for the release along with a description of those
taking on each of the release roles.
It can also include a preview of work aimed for the release after the
upcoming one.</p></li>
</ul>
</section>
<section id="week-before-feature-freeze">
<h3>1 week before Feature Freeze<a class="headerlink" href="#week-before-feature-freeze" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Check that all people with release roles are added to the <em>#release-roles</em>
Slack channel and others are removed.</p></li>
<li><p>Post on the <em>#annoucements</em> slack channel reminding developers of the impending
release and stating that they have only 5 days left before the feature freeze.</p></li>
<li><p>Hold the release showcase meeting described above.</p></li>
</ul>
</section>
<section id="feature-freeze-begins">
<h3>Feature Freeze Begins<a class="headerlink" href="#feature-freeze-begins" title="Link to this heading">#</a></h3>
<ul>
<li><p>Ask the technical release managers to organize for the release branch to be created.</p></li>
<li><p>Create a <a class="reference external" href="https://github.com/orgs/mantidproject/projects/">project board</a> to
track the issues for the release</p></li>
<li><p>After the message that the release branch has been created, post on the
<em>#annoucements</em> slack channel that only critical work should be merged to
that branch. You can use an adapted version of the
following announcement:</p>
<ul>
<li><p>We are now in feature freeze. Only critical work should be added to the release-next branch.
I have created a project board to track work for release <em><version></em> - please add any critical issues/PRs to this project, and ensure they have the <em><version></em> milestone.
I will be clearing the <em><version></em> milestone from anything not in this project later today (you can always re-add it if necessary).
Non critical work can be added to the <em><version+1></em> milestone and merged to the main branch as usual.</p>
<p><em><project link url></em></p>
</li>
</ul>
</li>
<li><p>Monitor the release project board and ensure items are assigned and moving through the board.
Show the board at standups.</p></li>
</ul>
</section>
<section id="id4">
<h3>Manual Testing<a class="headerlink" href="#id4" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Ensure that PR testing has been completed for PRs from before the feature freeze.</p></li>
</ul>
<p><strong>Clearing the Project Board</strong></p>
<p>Go through the issues for the release milestone (not the sprint milestone), ensuring that:</p>
<ul class="simple">
<li><p>All issues are intended for the release.</p></li>
<li><p>Any new issues are triaged on a daily basis, and allocated to staff.</p></li>
<li><p>Issues that are not important for the release should be moved to a more
appropriate milestone. Don’t leave anything in the release milestone that is not
definitely for that release.</p></li>
</ul>
<p><strong>Maintenance</strong></p>
<ul class="simple">
<li><p>Present to the whole development team the maintenance tasks for this release period.</p></li>
<li><p>Emphasize the order of work priorities as noted by the task priorities in this
checklist. Maintenance tasks may need to be paused to work on tasks for the release.</p></li>
</ul>
</section>
<section id="id5">
<h3>Beta Testing Begins<a class="headerlink" href="#id5" title="Link to this heading">#</a></h3>
<ul>
<li><p>On the date when the beta-testing is scheduled to start check with the technical
release managers that a build has been successful that we are happy to put out.</p></li>
<li><p>Send an email to beta test users explaining where to download the installers and how
to report issues (cc the Local Project Managers so they can organise a similar message
at their facilities). The following emails are used for beta testing:</p>
<p><code class="docutils literal notranslate"><span class="pre">ISISInstsci<AT>stfc.ac.uk</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">twg<AT>mantidproject.org</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">swg<AT>mantidproject.org</span></code></p>
<p>using the following templates as a guide (the first template is for users at ISIS, the second one for everyone else):</p>
<ul>
<li><p>Dear all,</p>
<p>We are busy preparing for the release of version <em><version></em> of Mantid.
We have completed our first round of developer testing and are now ready for beta-testing feedback.
The beta testing period for this release is between today (<em><start date></em>) and the end of play on <em><end date></em>.
We then hope to release the following week.</p>
<p>To test the Mantid nightly version, it is recommended to install it as a conda package in a new conda environment. To achieve this, use the
following command:</p>
<p><code class="docutils literal notranslate"><span class="pre">mamba</span> <span class="pre">create</span> <span class="pre">-n</span> <span class="pre">mantid_env_test</span> <span class="pre">-c</span> <span class="pre">mantid/label/nightly</span> <span class="pre">mantidworkbench</span></code></p>
<p>Alternatively, the nightly test installers for this version are available here to download: <a class="github reference external" href="https://github.com/mantidproject/mantid/releases">mantidproject/mantid</a>.
The nightly builds install alongside a full release and so will not affect its operation but will overwrite any other nightly builds you have.
For Windows users at ISIS, install Mantid as your standard user account (not an 03 account).
It will install just for your user, rather than for the whole PC.
Another possibility is to conduct testing on IDAaaS.</p>
<p>We have an early draft of the release notes at <a class="reference external" href="https://docs.mantidproject.org/nightly/release">https://docs.mantidproject.org/nightly/release</a>/<version>/index.html.</p>
<p>Please report any problems or bugs to <code class="docutils literal notranslate"><span class="pre">mantid-help@mantidproject.org</span></code>
If the problem is a bug that would prevent your normal workflow then start the email subject with <code class="docutils literal notranslate"><span class="pre">URGENT:</span></code>.
It would be most helpful for the team if bugs are communicated back to us as soon as possible.</p>
<p>Thank you all for your help.</p>
<p>Regards,</p>
<p>Mantid Team</p>
</li>
<li><p>Dear all,</p>
<p>We are busy preparing for the release of version <em><version></em> of Mantid.
We have completed our first round of developer testing and are now ready for beta-testing feedback.
The beta testing period for this release is between today (<em><start date></em>) and the end of play on <em><end date></em>.
We then hope to release the following week.</p>
<p>To test the Mantid nightly version, it is recommended to install it as a conda package in a new conda environment. To achieve this, use the
following command:</p>
<p><code class="docutils literal notranslate"><span class="pre">mamba</span> <span class="pre">create</span> <span class="pre">-n</span> <span class="pre">mantid_env_test</span> <span class="pre">-c</span> <span class="pre">mantid/label/nightly</span> <span class="pre">mantidworkbench</span></code></p>
<p>Alternatively, the nightly test installers for this version are available here to download: <a class="github reference external" href="https://github.com/mantidproject/mantid/releases">mantidproject/mantid</a>.
The nightly builds install alongside a full release and so will not affect its operation but will overwrite any other nightly builds you have.</p>
<p>We have an early draft of the release notes at <a class="reference external" href="https://docs.mantidproject.org/nightly/release">https://docs.mantidproject.org/nightly/release</a>/<version>/index.html.</p>
<p>Please report any problems or bugs to <code class="docutils literal notranslate"><span class="pre">mantid-help@mantidproject.org</span></code>.
If the problem is a bug that would prevent your normal workflow then start the email subject with <code class="docutils literal notranslate"><span class="pre">URGENT:</span></code>.
It would be most helpful for the team if bugs are communicated back to us as soon as possible.</p>
<p>Thank you all for your help.</p>
<p>Regards,</p>
<p>Mantid Team</p>
</li>
</ul>
</li>
<li><p>Ensure the other facilities forward the beta-testing email to their relevant internal lists.</p></li>
</ul>
</section>
<section id="reminder-email-for-beta">
<h3>Reminder Email for Beta<a class="headerlink" href="#reminder-email-for-beta" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Mid-way through the beta testing period, send a reminder email to beta test users thanking them for their feedback so
far and reminding them to feedback as soon as possible and not to send in a list of
issues at the end of testing (cc the Local Project Managers so they can organise a
similar message at their facilities).</p></li>
</ul>
</section>
<section id="id6">
<h3>Beta Testing Ends<a class="headerlink" href="#id6" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>At the end of the day, email the beta test users thanking them.</p></li>
<li><p>Review the complete set of release notes to make sure there are no glaring mistakes.</p></li>
</ul>
</section>
<section id="id7">
<h3>Smoke Testing<a class="headerlink" href="#id7" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>This is the final day for code changes to the build for blocker issues.</p></li>
</ul>
</section>
<section id="release-day">
<span id="release-manager-announcements"></span><h3>Release Day<a class="headerlink" href="#release-day" title="Link to this heading">#</a></h3>
<p>After the Technical Release Manager has finished their release day tasks:</p>
<ul>
<li><p>Send an email, including the text of the release notes, to the following lists, replacing <at> with the appropriate sign:</p>
<p><code class="docutils literal notranslate"><span class="pre">nobugs<at>nobugsconference.org</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">news<at>neutronsources.org</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">neutron<at>neutronsources.org</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">announcements<at>mantidproject.org</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">ISIS</span> <span class="pre">Instrument</span> <span class="pre">Scientists</span> <span class="pre">+</span> <span class="pre">Other</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">supportanalysis<at>stfc.ac.uk</span></code></p>
</li>
<li><p>Also post the contents of the message to the <em>#announcements</em> channel on
Slack.</p></li>
<li><p>Create a new item on the forum news.</p></li>
<li><p>Add a news item linking to the forum post on the <a class="reference external" href="https://www.mantidproject.org">mantidproject website</a>
by manually editing <a class="reference external" href="https://github.com/mantidproject/www/blob/main/source/_templates/sidebar-news.html">sidebar-news.html</a>.
Restrict the number of news items to five.</p></li>
<li><p>Close the release milestone on GitHub.</p></li>
</ul>
</section>
</section>
<section id="technical-release-managers-checklist">
<span id="technical-release-manager-checklist"></span><h2>Technical Release Managers Checklist<a class="headerlink" href="#technical-release-managers-checklist" title="Link to this heading">#</a></h2>
<p><strong>Role</strong>: People responsible for technical tasks such as renaming branches, creating
tags, configuring build servers, and ensuring problems on the Release Pipeline get fixed
(by themselves or others).</p>
<section id="id8">
<h3>Code Freeze<a class="headerlink" href="#id8" title="Link to this heading">#</a></h3>
<p><strong>Create the Release Branch (once most PRs are merged)</strong></p>
<ul class="simple">
<li><p>Ensure the latest <a class="reference external" href="https://builds.mantidproject.org/view/Nightly%20Pipelines/job/main_nightly/">main nightly pipeline</a>
has passed for all build environments. If it fails, decide if a fix is needed before moving on to
the next steps.</p></li>
<li><p>Ask a mantid gatekeeper or administrator to update the <code class="docutils literal notranslate"><span class="pre">release-next</span></code> branch so that it’s up to
date with the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch, pushing the changes directly to GitHub:</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>checkout<span class="w"> </span>release-next
git<span class="w"> </span>fetch<span class="w"> </span>origin<span class="w"> </span>main
git<span class="w"> </span>reset<span class="w"> </span>--hard<span class="w"> </span>origin/main
git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>release-next<span class="w"> </span>--force
</pre></div>
</div>
<ul class="simple">
<li><p>Verify that the latest commit on <code class="docutils literal notranslate"><span class="pre">release-next</span></code> is correct before moving to the next step.</p></li>
<li><p>Click <code class="docutils literal notranslate"><span class="pre">Build</span> <span class="pre">Now</span></code> on <a class="reference external" href="https://builds.mantidproject.org/view/All/job/open-release-testing/">open-release-testing</a>. This will
set the value of the Jenkins global property <code class="docutils literal notranslate"><span class="pre">BRANCH_TO_PUBLISH</span></code> to <code class="docutils literal notranslate"><span class="pre">release-next</span></code>,
which will re-enable package publishing for the <code class="docutils literal notranslate"><span class="pre">release-next</span></code> nightly pipeline.</p></li>
<li><p>Set the value of the <a class="reference external" href="https://github.com/mantidproject/mantid/settings/variables/actions">github actions variable</a> <code class="docutils literal notranslate"><span class="pre">BRANCH_TO_PUBLISH</span></code> to <code class="docutils literal notranslate"><span class="pre">release-next</span></code>. This will set the target branch used by <a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/.github/workflows/pixi-update.yml">github workflow</a> for updating pixi lock file. And the same variable is also used to <a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/.github/workflows/add-milestone.yml">determine the milestone</a> for pull requests without an assigned milestone.</p></li>
<li><p>Check the state of all open pull requests for this milestone and decide which
should be kept for the release, liaise with the Release Manager on this. Move any
pull requests not targeted for this release out of the milestone, and then change
the base branch of the remaining pull requests to <code class="docutils literal notranslate"><span class="pre">release-next</span></code>. You can either
manually change the base branch in GitHub or use the <a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/tools/scripts/update-pr-base-branch.py">update-pr-base-branch.py</a>
script to update the base branches of these pull requests.
A quick example to show how the arguments should be provided to this script is seen below:</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>update-pr-base-branch.py<span class="w"> </span><span class="o">[</span>milestone<span class="o">]</span><span class="w"> </span><span class="o">[</span>newbase<span class="o">]</span><span class="w"> </span>--token<span class="w"> </span><span class="o">[</span>generated_token<span class="o">]</span>
python<span class="w"> </span>update-pr-base-branch.py<span class="w"> </span><span class="s2">"Release 6.1"</span><span class="w"> </span><span class="s2">"release-next"</span><span class="w"> </span>--token<span class="w"> </span>fake123gener8ed456token
</pre></div>
</div>
<ul class="simple">
<li><p>Inform other developers that <code class="docutils literal notranslate"><span class="pre">release-next</span></code> has been created by posting to the
<em>#announcements</em> slack channel. You can use an adapted version of the
following announcement:</p>
<ul>
<li><p>The release branch for <version>, called <code class="docutils literal notranslate"><span class="pre">release-next</span></code>, has now been created:
<a class="github reference external" href="https://github.com/mantidproject/mantid/tree/release-next">mantidproject/mantid</a>. If you’ve not worked with
the release/main/-branch workflow before then please take a moment to familiarise
yourself with the process: <a class="reference external" href="https://developer.mantidproject.org/GitWorkflow.html#code-freeze">https://developer.mantidproject.org/GitWorkflow.html#code-freeze</a>.
The part about ensuring new branches have the correct parent is the most important part
(although this can be corrected afterwards). All branches and PRs that were created
before this release branch was created are fine, as their history is the same as <code class="docutils literal notranslate"><span class="pre">main</span></code>.</p></li>
</ul>
</li>
</ul>
<p><strong>Create Release Notes Skeleton</strong></p>
<ul class="simple">
<li><p>Create a skeleton set of release notes and subfolders on <code class="docutils literal notranslate"><span class="pre">main</span></code> for the next version using the
<a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/tools/release_generator/release.py">python helper tool</a>
and open a pull request to put them on <code class="docutils literal notranslate"><span class="pre">main</span></code>. Make sure the
<code class="docutils literal notranslate"><span class="pre">docs/source/release/index.rst</span></code> file has a link to the new release docs.</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>release.py<span class="w"> </span>--release<span class="w"> </span><span class="o">[</span>X.Y.Z<span class="o">]</span><span class="w"> </span>--milestone<span class="w"> </span><span class="o">[</span>milestone<span class="o">]</span>
python<span class="w"> </span>release.py<span class="w"> </span>--release<span class="w"> </span><span class="m">6</span>.1.0<span class="w"> </span>--milestone<span class="w"> </span><span class="s2">"Release 6.1"</span>
</pre></div>
</div>
</section>
<section id="id9">
<h3>Smoke Testing<a class="headerlink" href="#id9" title="Link to this heading">#</a></h3>
<p>Check with the Quality Assurance Manager that the initial Manual testing has been completed, and any issues
have been fixed. Then:</p>
<ul class="simple">
<li><p>Liaise with the release editor to ensure that they have completed all of their tasks.</p></li>
<li><p>Check the release notes and verify that the “Under Construction” paragraph on the main
index page has been removed. Remove the paragraph if it still exists.</p></li>
<li><p>Ensure that all changes, including release notes, have been merged into the <code class="docutils literal notranslate"><span class="pre">release-next</span></code> branch.</p></li>
<li><p>Make sure the <code class="docutils literal notranslate"><span class="pre">release-next</span></code> branch is fully merged into <code class="docutils literal notranslate"><span class="pre">main</span></code>. If required, manually run the <a class="reference external" href="https://github.com/mantidproject/mantid/actions/workflows/automerge.yml/">GitHub workflow</a> using the <code class="docutils literal notranslate"><span class="pre">release-next</span></code> branch to
merge the changes.</p></li>
</ul>
<p><strong>Create the Release Candidates For Smoke Testing</strong></p>
<p>We are now ready to create the release candidates for Smoke testing.</p>
<ul class="simple">
<li><p>Build the <a class="reference external" href="https://builds.mantidproject.org/view/Nightly%20Pipelines/job/release-next_nightly/">release-next_nightly Jenkins pipeline</a>
with the following parameters (most are already defaulted to the correct values):</p>
<ul>
<li><p>set <code class="docutils literal notranslate"><span class="pre">DESCRIPTION</span></code> to <code class="docutils literal notranslate"><span class="pre">Smoke</span> <span class="pre">testing</span> <span class="pre">candidates</span> <span class="pre">vX.Y.ZrcN</span></code></p></li>
<li><p>set <code class="docutils literal notranslate"><span class="pre">BUILD_DEVEL</span></code> to <code class="docutils literal notranslate"><span class="pre">all</span></code></p></li>
<li><p>set <code class="docutils literal notranslate"><span class="pre">BUILD_PACKAGE</span></code> to <code class="docutils literal notranslate"><span class="pre">all</span></code></p></li>
<li><p>set <code class="docutils literal notranslate"><span class="pre">PACKAGE_SUFFIX</span></code> to an <strong>empty string</strong></p></li>
<li><p>tick the <code class="docutils literal notranslate"><span class="pre">PUBLISH_TO_ANACONDA</span></code> checkbox</p></li>
<li><p>tick the <code class="docutils literal notranslate"><span class="pre">PUBLISH_TO_GITHUB</span></code> checkbox</p></li>
<li><p>set the <code class="docutils literal notranslate"><span class="pre">ANACONDA_CHANNEL</span></code> to <code class="docutils literal notranslate"><span class="pre">mantid-test</span></code></p></li>
<li><p>set the <code class="docutils literal notranslate"><span class="pre">ANACONDA_CHANNEL_LABEL</span></code> to <code class="docutils literal notranslate"><span class="pre">vX.Y.ZrcN</span></code> where <code class="docutils literal notranslate"><span class="pre">X.Y.Z</span></code> is the release number,
and <code class="docutils literal notranslate"><span class="pre">N</span></code> is an incremental build number for release candidates, starting at <code class="docutils literal notranslate"><span class="pre">1</span></code> (e.g. <code class="docutils literal notranslate"><span class="pre">v6.7.0rc1</span></code>)</p></li>
<li><p>set <code class="docutils literal notranslate"><span class="pre">GITHUB_RELEASES_REPO</span></code> to <code class="docutils literal notranslate"><span class="pre">mantidproject/mantid</span></code></p></li>
<li><p>set <code class="docutils literal notranslate"><span class="pre">GITHUB_RELEASES_TAG</span></code> to <code class="docutils literal notranslate"><span class="pre">vX.Y.ZrcN</span></code>, where <code class="docutils literal notranslate"><span class="pre">X.Y.Z</span></code> is the release number,
and <code class="docutils literal notranslate"><span class="pre">N</span></code> is an incremental build number for release candidates, starting at <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p></li>
</ul>
</li>
<li><p>Once the packages have been published to GitHub and Anaconda, ask someone in the ISIS core or DevOps
team to manually sign the Windows binary and re-upload it to the GitHub
<a class="reference external" href="https://github.com/mantidproject/mantid/releases">draft release</a>.</p></li>
<li><p>Liaise with the Quality Assurance Manager and together announce the creation of the smoke testing
issues and Release Candidates in the <em>#general</em> slack channel.</p></li>
</ul>
</section>
<section id="create-final-release-candidates">
<span id="technical-release-manager-release-candidates"></span><h3>Create Final Release Candidates<a class="headerlink" href="#create-final-release-candidates" title="Link to this heading">#</a></h3>
<p>Check with the Quality Assurance Manager that the Smoke testing has been completed, and any issues
have been fixed. Additionally, ensure that the version of the <code class="docutils literal notranslate"><span class="pre">mslice</span></code> package in <code class="docutils literal notranslate"><span class="pre">conda_build_config.yaml</span></code> is correct.
If there have been any updates to MSlice since the last release, it must be released first. The release candidates must
now be recreated with their final version numbers. To do this, build the
<a class="reference external" href="https://builds.mantidproject.org/view/Nightly%20Pipelines/job/release-next_nightly/">release-next_nightly Jenkins pipeline</a>
with the following parameters (most are already defaulted to the correct values):</p>
<ul class="simple">
<li><p>set <code class="docutils literal notranslate"><span class="pre">DESCRIPTION</span></code> to <code class="docutils literal notranslate"><span class="pre">Release</span> <span class="pre">build</span> <span class="pre">for</span> <span class="pre">vX.Y.Z</span></code></p></li>
<li><p>set <code class="docutils literal notranslate"><span class="pre">BUILD_DEVEL</span></code> to <code class="docutils literal notranslate"><span class="pre">all</span></code></p></li>
<li><p>set <code class="docutils literal notranslate"><span class="pre">BUILD_PACKAGE</span></code> to <code class="docutils literal notranslate"><span class="pre">all</span></code></p></li>
<li><p>set <code class="docutils literal notranslate"><span class="pre">PACKAGE_SUFFIX</span></code> to an <strong>empty string</strong></p></li>
<li><p>tick the <code class="docutils literal notranslate"><span class="pre">PUBLISH_TO_ANACONDA</span></code> checkbox</p></li>
<li><p>tick the <code class="docutils literal notranslate"><span class="pre">PUBLISH_TO_GITHUB</span></code> checkbox</p></li>
<li><p>set the <code class="docutils literal notranslate"><span class="pre">ANACONDA_CHANNEL</span></code> to <code class="docutils literal notranslate"><span class="pre">mantid</span></code></p></li>
<li><p>set the <code class="docutils literal notranslate"><span class="pre">ANACONDA_CHANNEL_LABEL</span></code> to <code class="docutils literal notranslate"><span class="pre">draft-vX.Y.Z</span></code> where <code class="docutils literal notranslate"><span class="pre">X.Y.Z</span></code> is the release number</p></li>
<li><p>set <code class="docutils literal notranslate"><span class="pre">GITHUB_RELEASES_REPO</span></code> to <code class="docutils literal notranslate"><span class="pre">mantidproject/mantid</span></code></p></li>
<li><p>set <code class="docutils literal notranslate"><span class="pre">GITHUB_RELEASES_TAG</span></code> to <code class="docutils literal notranslate"><span class="pre">vX.Y.Z</span></code>, where <code class="docutils literal notranslate"><span class="pre">X.Y.Z</span></code> is the release number.</p></li>
</ul>
</section>
<section id="technical-release-manager-release-day">
<span id="id10"></span><h3>Release Day<a class="headerlink" href="#technical-release-manager-release-day" title="Link to this heading">#</a></h3>
<p>Once the final release candidate pipeline has succeeded, the draft release will be available on GitHub and our
Anaconda channel.</p>
<ul class="simple">
<li><p>Edit the <a class="reference external" href="https://github.com/mantidproject/mantid/releases">draft release</a> on
GitHub. The description of the new release can be copied from the release notes <code class="docutils literal notranslate"><span class="pre">index.rst</span></code> file, and
edited appropriately. See previous release descriptions for inspiration.</p></li>
<li><p>Ask someone in the ISIS core or DevOps team to manually sign the Windows binary and re-upload it to the draft
release.</p></li>
<li><p>Publish the GitHub release. This will publish the tag required to generate the DOI.</p></li>
<li><p>Remove the smoke testing release from the GitHub releases page (the one tagged with <code class="docutils literal notranslate"><span class="pre">vX.Y.ZrcN</span></code>).</p></li>
<li><p>Change the labels for the release candidates on our <a class="reference external" href="https://anaconda.org/mantid/mantid/files">Anaconda site</a>
from <code class="docutils literal notranslate"><span class="pre">draft-vX.Y.Z</span></code> to <code class="docutils literal notranslate"><span class="pre">main</span></code>. You may need to ask a member of the ISIS core or DevOps team to do this.</p></li>
<li><p>Remove the smoke testing release candidates from our Anaconda channel (those with the <code class="docutils literal notranslate"><span class="pre">vX.Y.ZrcN</span></code> label).</p></li>
<li><p>Update the <a class="reference external" href="https://download.mantidproject.org">download page</a> by running the <a class="reference external" href="https://github.com/mantidproject/www/actions/workflows/update-latest-release.yml">Update latest release links</a> workflow in the
<a class="reference external" href="https://github.com/mantidproject/www">mantidproject/www repository</a>.</p></li>
<li><p>Ask someone with access to the <a class="reference external" href="https://github.com/ral-facilities/daaas-ansible-workspace">daaas-ansible-workspace repository</a> (a member of the ISIS core team or IDAaaS support)
to add the new release to IDAaaS. They can do this by creating a PR targeting the <code class="docutils literal notranslate"><span class="pre">preprod</span></code> branch, adding
the new release version to the list of versions installed on IDAaaS <a class="reference external" href="https://github.com/ral-facilities/daaas-ansible-workspace/blob/main/roles/software/analysis/mantid/defaults/main.yml">here</a>.
Make sure that there are only three <code class="docutils literal notranslate"><span class="pre">mantid_versions</span></code> in the list (delete the oldest one if applicable).
The changes need to be verified on an IDAaaS test instance before the PR can be accepted.</p></li>
<li><p>Run the <a class="reference external" href="https://builds.mantidproject.org/view/All/job/close-release-testing">close-release-testing</a> Jenkins job.
This will set the value of the Jenkins global property <code class="docutils literal notranslate"><span class="pre">BRANCH_TO_PUBLISH</span></code> to <code class="docutils literal notranslate"><span class="pre">main</span></code>, which will re-enable package
publishing for the <code class="docutils literal notranslate"><span class="pre">main</span></code> nightly pipeline.</p></li>
<li><p>Set the value of the <a class="reference external" href="https://github.com/mantidproject/mantid/settings/variables/actions">github actions variable</a> <code class="docutils literal notranslate"><span class="pre">BRANCH_TO_PUBLISH</span></code> back to <code class="docutils literal notranslate"><span class="pre">main</span></code>.</p></li>
</ul>
<p><strong>Generate DOI</strong></p>
<p>This requires that a tag has been created for this release. This tag is created when you draft and
publish a new <a class="reference external" href="https://github.com/mantidproject/mantid/releases">release</a> on GitHub.</p>
<ul class="simple">
<li><p>Make sure that you have updated your local copy of git to grab the new tag.
<code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">fetch</span> <span class="pre">-p</span></code></p></li>
<li><p>If the script below fails you may need to update the authors list and push the
updates to <code class="docutils literal notranslate"><span class="pre">main</span></code>. Look for <code class="docutils literal notranslate"><span class="pre">authors.py</span></code> in the <code class="docutils literal notranslate"><span class="pre">tools/DOI</span></code> directory.
It does not matter that these are not on the release branch.</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>tools/DOI/doi.py<span class="w"> </span>--username<span class="o">=[</span>username<span class="o">]</span><span class="w"> </span><span class="o">[</span>X.Y.Z<span class="o">]</span>
</pre></div>
</div>
<ul class="simple">
<li><p>The script will prompt you for the password. Ask a senior developer to share the username and
password with you if you do not already have access to it.</p></li>
</ul>
<p><strong>Update Citation File</strong></p>
<p>Open a PR updating the software <code class="docutils literal notranslate"><span class="pre">doi</span></code>, <code class="docutils literal notranslate"><span class="pre">date-released</span></code> and <code class="docutils literal notranslate"><span class="pre">version</span></code> in the <code class="docutils literal notranslate"><span class="pre">CITATION.cff</span></code> file
at the root of the repository.</p>
<p><strong>Deploy Versioned Documentation</strong></p>
<p>Versioned documentation is accessible at <a class="reference external" href="https://docs.mantidproject.org/vX.Y.Z/">https://docs.mantidproject.org/vX.Y.Z/</a>.
This documentation is hosted at <a class="reference external" href="https://mantidproject.github.io/docs-versioned/vX.Y.Z/">https://mantidproject.github.io/docs-versioned/vX.Y.Z/</a>.
Documentation is deployed to GitHub via an action on the <a class="reference external" href="https://github.com/mantidproject/docs-versioned">docs-versioned</a> repository.
This action runs on a push to the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch of the repository.</p>
<p>To do this:</p>
<ul class="simple">
<li><p>On a clone of the mantid repository, check out the commit tagged as the relevant release number: <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">tags/<vX.Y.Z></span> <span class="pre">-b</span> <span class="pre"><new</span> <span class="pre">branch</span> <span class="pre">name></span></code>.</p></li>
<li><p>On this branch, build the <code class="docutils literal notranslate"><span class="pre">docs-html</span></code> target (this target is produced by <code class="docutils literal notranslate"><span class="pre">CMake</span></code>).</p></li>
<li><p>Clone the repository: <a class="github reference external" href="https://github.com/mantidproject/docs-versioned">mantidproject/docs-versioned</a>.</p></li>
<li><p>Remaining on the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch, create a directory for the relevant release in the form <code class="docutils literal notranslate"><span class="pre">vX.Y.Z</span></code>.</p></li>
<li><p>Copy the built documentation into this new directory. The built documentation will be in your mantid build directory at <code class="docutils literal notranslate"><span class="pre"><build</span> <span class="pre">directory>/docs/html</span></code>.</p></li>
<li><p>Stage the newly created directory and commit it to your branch.</p></li>
<li><p>After double-checking that these instructions have been followed correctly, push your branch to the main repository to deploy.</p></li>
</ul>
<p>Notify the Release Manager when you complete all your tasks.</p>
</section>
</section>
</section>