-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGitWorkflow.html
More file actions
671 lines (526 loc) · 35.5 KB
/
Copy pathGitWorkflow.html
File metadata and controls
671 lines (526 loc) · 35.5 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
<!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>Mantid Git Workflow — 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=a95f357e85573c9b56d5" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=a95f357e85573c9b56d5" 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=a95f357e85573c9b56d5"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=a95f357e85573c9b56d5" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=a95f357e85573c9b56d5" />
<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 = 'GitWorkflow';</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="The Automated Build Process" href="AutomatedBuildProcess.html" />
<link rel="prev" title="Mantid Git Config" href="GitConfig.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 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 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 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 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 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 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 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 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 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 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 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 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 id="pst-collapse-sidebar-button" aria-expanded="true" aria-controls="pst-primary-sidebar"><svg class="pst-icon svg-inline--fa" 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">Mantid Git Workflow</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="mantid-git-workflow">
<span id="gitworkflow"></span><h1>Mantid Git Workflow<a class="headerlink" href="#mantid-git-workflow" title="Link to this heading">#</a></h1>
<section id="summary">
<h2>Summary<a class="headerlink" href="#summary" title="Link to this heading">#</a></h2>
<p>Go to the <a class="reference internal" href="GitConfig.html"><span class="doc">Mantid Git Config</span></a> page to ensure that Git is set up correctly
before starting.</p>
<p>This page describes the workflow used in conjunction with <a class="reference external" href="http://git-scm.com">Git</a> and <a class="reference external" href="https://www.github.com/">GitHub</a> for
those who have push access to the repository.</p>
<p>Go <a class="reference external" href="https://education.github.com/git-cheat-sheet-education.pdf">here</a>
or <a class="reference external" href="https://www.atlassian.com/git/tutorials/atlassian-git-cheatsheet">here</a>
for a cheatsheet of Git commands.</p>
<p>Go <a class="reference external" href="https://github.com/k88hudson/git-flight-rules">here</a> for a
(fairly) comprehensive guide to solving your various Git problems.</p>
</section>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Link to this heading">#</a></h2>
<p>We follow the <a class="reference external" href="https://guides.github.com/introduction/flow/index.html">GitHub flow</a>, using
branches for new work and pull requests for verifying the work.</p>
<p>The steps for a new piece of work can be summarised as follows:</p>
<ol class="arabic simple">
<li><p>Push up or <a class="reference external" href="https://guides.github.com/features/issues">create</a> an
issue <a class="reference external" href="https://github.com/mantidproject/mantid/issues">here</a></p></li>
<li><p>Create a branch from <code class="docutils literal notranslate"><span class="pre">main</span></code> using the naming convention described
at <a class="reference internal" href="#gitworkflownamingbranches"><span class="std std-ref">Naming Branches</span></a></p></li>
<li><p>Do the work and commit changes to the branch. On commit, the
<a class="reference external" href="https://pre-commit.com/">pre-commit</a> framework will run, it will
check all your changes for formatting, linting, and perform static
analysis. Push the branch regularly to GitHub to make sure no work
is accidentally lost.</p></li>
<li><p>When you are finished with the work, ensure that all of the unit
tests, documentation tests and system tests if necessary pass on
your own machine</p></li>
<li><p>Open a pull request (<a class="reference internal" href="#gitworkflowpullrequests"><span class="std std-ref">Pull Requests</span></a>)
from the <a class="reference external" href="https://github.com/mantidproject/mantid/branches/">GitHub branches</a> page</p>
<ul class="simple">
<li><p>This will check with the buildservers for cross-platform
compatibility</p></li>
<li><p>If any issues come up, continue working on your branch and push
to GitHub - the pull request will update automatically</p></li>
</ul>
</li>
</ol>
</section>
<section id="naming-branches">
<span id="gitworkflownamingbranches"></span><h2>Naming Branches<a class="headerlink" href="#naming-branches" title="Link to this heading">#</a></h2>
<p>When naming <a class="reference external" href="http://github.com/mantidproject/mantid/branches">public branches</a> that will be
pushed to GitHub, please follow the convention of
<code class="docutils literal notranslate"><span class="pre">issuenumber_short_description</span></code>. This will allow others to discover
what the branch is for (issue number) and quickly know what is being
done there (short description).</p>
</section>
<section id="git-blame">
<h2>Git Blame<a class="headerlink" href="#git-blame" title="Link to this heading">#</a></h2>
<p>The refspecs listed in this file are ignored by <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">blame</span></code> when git is configured correctly.
This is mostly used to hide commits that are created by bots (e.g. formatting)
The refspecs must be listed in commit order from oldest to newest.
Github does this automatically in the <a class="reference external" href="https://docs.github.com/en/repositories/working-with-files/using-files/viewing-and-understanding-files#ignore-commits-in-the-blame-view">blame view of a file</a></p>
<p>To configure it locally (examples assume you are in the root of your local clone), add it as an option to git blame</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>blame<span class="w"> </span>--ignore-revs-file<span class="w"> </span>.git-blame-ignore-revs
</pre></div>
</div>
<p>or configure your local git instance</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>config<span class="w"> </span>blame.ignoreRevsFile<span class="w"> </span>.git-blame-ignore-revs
</pre></div>
</div>
</section>
<section id="pull-requests">
<span id="gitworkflowpullrequests"></span><h2>Pull Requests<a class="headerlink" href="#pull-requests" title="Link to this heading">#</a></h2>
<p>For an general overview of using pull requests on GitHub look <a class="reference external" href="https://help.github.com/articles/using-pull-requests/">here</a>.</p>
<p>When creating a pull request you should:</p>
<ul class="simple">
<li><p>Ensure that the title succinctly describes the changes so it is easy
to read on the overview page</p>
<ul>
<li><p>The title should <strong>not</strong> contain the issue number</p></li>
</ul>
</li>
<li><p><a class="reference external" href="https://github.com/blog/1506-closing-issues-via-pull-requests">Reference the issue which the pull request is closing</a>, using one of <a class="reference external" href="https://help.github.com/articles/closing-issues-via-commit-messages">these</a> keywords</p></li>
<li><p>State the user and facility (if relevant) who initiated the original issue, if they are named in the issue. Please do not put full email addresses on the Pull Request, as it is publicly accessible.
If the user would not be easily identified by someone picking up the ticket, be prepared to act as a point of contact with the reporter.</p></li>
<li><p>Ensure the description follows the format described by the <a class="reference external" href="https://github.com/mantidproject/mantid/blob/main/.github/PULL_REQUEST_TEMPLATE.md">PR
template</a>
on GitHub</p></li>
</ul>
<p>A good example is <a class="reference external" href="https://github.com/mantidproject/mantid/pull/18713">here</a>.</p>
<p>Recommended reading: <a class="reference external" href="https://github.com/blog/1943-how-to-write-the-perfect-pull-request">How to Write the Perfect Pull Request</a></p>
<p>For further information about the review process see <a class="reference internal" href="ReviewingAPullRequest.html#reviewingapullrequest"><span class="std std-ref">reviewing a pull request</span></a>.</p>
<section id="checkout-a-pull-request">
<h3>Checkout a Pull Request<a class="headerlink" href="#checkout-a-pull-request" title="Link to this heading">#</a></h3>
<p>To check out a particular pull request for functional testing use the <code class="docutils literal notranslate"><span class="pre">test-pr</span></code> alias that was set up in the <a class="reference internal" href="GitConfig.html"><span class="doc">Mantid Git Config</span></a> instructions.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>test-pr<span class="w"> </span><remote-name><span class="w"> </span><ID>
</pre></div>
</div>
<p>where <code class="docutils literal notranslate"><span class="pre"><ID></span></code> is the pull request number given on GitHub and <code class="docutils literal notranslate"><span class="pre"><remote-name></span></code> is the name
of the remote pointing to the original <code class="docutils literal notranslate"><span class="pre">mantid</span></code> repository. If you cloned directly from <a class="reference external" href="https://github.com/mantidproject/mantid">mantid</a>
then <code class="docutils literal notranslate"><span class="pre">remote-name=origin</span></code> else if you cloned from a fork then it is the name of remote that points
back to the original repository.</p>
<p>Note that these commands will checkout a temporary branch that has the development branch merged with <code class="docutils literal notranslate"><span class="pre">main</span></code> and not just
the development branch on its own.</p>
<p>The <a class="reference internal" href="GitConfig.html"><span class="doc">Mantid Git Config</span></a> page also provides the follow alias to delete all <code class="docutils literal notranslate"><span class="pre">pr/</span></code> prefixed branches, which is useful if you have several:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>test-pr-remove-all
</pre></div>
</div>
</section>
<section id="stale-pull-requests">
<h3>Stale Pull Requests<a class="headerlink" href="#stale-pull-requests" title="Link to this heading">#</a></h3>
<p>Pull requests that go an extended period of time without any activity
are considered stale and will be picked up by a (partially) automated
bot which will notify those that are required to take action in order
to keep the review process going.</p>
<p>This is also used to notify developers of pull requests that develop
conflicts with the base branch and that fail continuous integration
tests, in those two cases the age of the pull request is ignored.</p>
<p>The reasons a pull request may be flagged up currently are:</p>
<ul class="simple">
<li><p>Conflicts with base branch</p></li>
<li><p>Failing CI</p></li>
<li><p>Last developer has left the Mantid team</p></li>
<li><p>Nobody has reviewed the PR</p></li>
<li><p>An assigned reviewer has yet to complete a review</p></li>
<li><p>A gatekeeper has not second reviewed an approved PR</p></li>
<li><p>A review from a specific user was requested but that user has yet to complete a review</p></li>
<li><p>The developer has yet to act on comments left in a review</p></li>
</ul>
<p>(code for the bot is currently <a class="reference external" href="https://github.com/DanNixon/mantid_pr_bot">here</a>)</p>
</section>
</section>
<section id="code-freeze">
<h2>Code Freeze<a class="headerlink" href="#code-freeze" title="Link to this heading">#</a></h2>
<p>At the start of a <em>code freeze</em> before a major release there will be a
release branch created named <code class="docutils literal notranslate"><span class="pre">release-next</span></code>. At this point
only bugfixes should be applied to this release branch so that it can
be stabilized for the release. The release branch will be merged to
<code class="docutils literal notranslate"><span class="pre">main</span></code> periodically so bugfixes do not need to be separately
merged to <code class="docutils literal notranslate"><span class="pre">main</span></code>.</p>
<section id="new-branches">
<h3>New Branches<a class="headerlink" href="#new-branches" title="Link to this heading">#</a></h3>
<p>During the code freeze it is important to ensure that a new branch is
created from the correct base branch depending on the scope of the
changes:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">main</span></code>: maintenance fixes, new features. Command: <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">fetch</span> <span class="pre">-p</span> <span class="pre">&&</span> <span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">--no-track</span> <span class="pre">-b</span> <span class="pre">MYBRANCH_NAME</span> <span class="pre">origin/main</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">release-next</span></code>: bugfixes. Command: <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">fetch</span> <span class="pre">-p</span> <span class="pre">&&</span> <span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">--no-track</span> <span class="pre">-b</span> <span class="pre">MYBRANCH_NAME</span> <span class="pre">origin/release-next</span></code></p></li>
</ul>
</section>
<section id="id1">
<h3>Pull Requests<a class="headerlink" href="#id1" title="Link to this heading">#</a></h3>
<p>To merge code with the release branch, open a pull request as usual but instead of using the
default merge target select <code class="docutils literal notranslate"><span class="pre">release-next</span></code>:</p>
<img alt="_images/release-branch-new-pr.png" src="_images/release-branch-new-pr.png" />
</section>
<section id="fixing-a-pr-with-an-incorrect-base-branch">
<h3>Fixing a PR with an Incorrect Base Branch<a class="headerlink" href="#fixing-a-pr-with-an-incorrect-base-branch" title="Link to this heading">#</a></h3>
<p>The target branch on GitHub needs to match the base branch used in the
commands above when the branch was initially created. If the compare
view shows changes other than your own it is most likely that the base
branch is incorrect and it needs to be fixed.</p>
<p>As an example consider the scenario where a branch named <code class="docutils literal notranslate"><span class="pre">topic</span></code> has
been based off the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch as follows:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">o</span><span class="o">---</span><span class="n">o</span><span class="o">---</span><span class="n">o</span><span class="o">---</span><span class="n">o</span><span class="o">---</span><span class="n">o</span> <span class="n">main</span>
<span class="o">|</span> \
<span class="o">|</span> <span class="n">o</span><span class="o">---</span><span class="n">o</span><span class="o">---</span><span class="n">o</span> <span class="n">topic</span>
\
<span class="n">o</span><span class="o">---</span><span class="n">o</span><span class="o">---</span><span class="n">o</span><span class="o">---</span><span class="n">o</span><span class="o">---</span><span class="n">o</span> <span class="n">release</span><span class="o">-</span><span class="nb">next</span>
</pre></div>
</div>
<p>where we actually want the <code class="docutils literal notranslate"><span class="pre">topic</span></code> branch based off <code class="docutils literal notranslate"><span class="pre">release-next</span></code>
instead i.e.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">o</span><span class="o">---</span><span class="n">o</span><span class="o">---</span><span class="n">o</span><span class="o">---</span><span class="n">o</span><span class="o">---</span><span class="n">o</span> <span class="n">main</span>
\
<span class="n">o</span><span class="o">---</span><span class="n">o</span><span class="o">---</span><span class="n">o</span><span class="o">---</span><span class="n">o</span><span class="o">---</span><span class="n">o</span> <span class="n">release</span><span class="o">-</span><span class="nb">next</span>
\
<span class="n">o</span><span class="s1">'---o'</span><span class="o">---</span><span class="n">o</span><span class="s1">' topic</span>
</pre></div>
</div>
<p>To fix this situation we use the <code class="docutils literal notranslate"><span class="pre">rebase</span></code> command, providing the
<code class="docutils literal notranslate"><span class="pre">--onto</span></code> option as follows:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>fetch
git<span class="w"> </span>rebase<span class="w"> </span>--onto<span class="w"> </span>origin/release-next<span class="w"> </span><span class="k">$(</span>git<span class="w"> </span>merge-base<span class="w"> </span>origin/main<span class="w"> </span>origin/topic<span class="k">)</span><span class="w"> </span>topic
</pre></div>
</div>
</section>
<section id="fixing-a-merge-conflict-between-protected-branches">
<h3>Fixing a merge conflict between protected branches<a class="headerlink" href="#fixing-a-merge-conflict-between-protected-branches" title="Link to this heading">#</a></h3>
<p>A Gatekeeper should follow <a class="reference internal" href="Gatekeeping.html#fixprotectedbranchmergeconflict"><span class="std std-ref">these instructions</span></a> if there is a merge conflict between two protected branches e.g. <code class="docutils literal notranslate"><span class="pre">main</span></code> and <code class="docutils literal notranslate"><span class="pre">release-next</span></code>.</p>
</section>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="GitConfig.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Mantid Git Config</p>
</div>
</a>
<a class="right-next"
href="AutomatedBuildProcess.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">The Automated Build Process</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav id="pst-page-toc-nav" class="page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="pst-show_toc_level nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#summary">Summary</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#description">Description</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#naming-branches">Naming Branches</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#git-blame">Git Blame</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pull-requests">Pull Requests</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#checkout-a-pull-request">Checkout a Pull Request</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#stale-pull-requests">Stale Pull Requests</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#code-freeze">Code Freeze</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#new-branches">New Branches</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id1">Pull Requests</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#fixing-a-pr-with-an-incorrect-base-branch">Fixing a PR with an Incorrect Base Branch</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#fixing-a-merge-conflict-between-protected-branches">Fixing a merge conflict between protected branches</a></li>
</ul>
</li>
</ul>
</nav></div>
<div class="sidebar-secondary-item">
<div class="tocsection sourcelink">
<a href="_sources/GitWorkflow.rst.txt">
<i class="fa-solid fa-file-lines"></i> Show Source
</a>
</div>
</div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=a95f357e85573c9b56d5"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=a95f357e85573c9b56d5"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2007-2026, Mantid.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.19.0.
</p></div>
</div>
</div>
</footer>
</body>
</html>