Gitiles
Code Review Sign In
review.blissroms.org / Documentation-release / 25f686617b0fe19d7ecd24770d0de5369ac28265 / . / common / using-dippy-bird / index.html
blob: d9a046d8b1943d9d04b191db60b5d9c2baa212d4 [file] [log] [blame]
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]1
2
3
4
5<!doctype html>
6<html lang="en" class="no-js">
7 <head>
8
9 <meta charset="utf-8">
10 <meta name="viewport" content="width=device-width,initial-scale=1">
11 <meta http-equiv="x-ua-compatible" content="ie=edge">
12
13
14
15
16 <meta name="lang:clipboard.copy" content="Copy to clipboard">
17
18 <meta name="lang:clipboard.copied" content="Copied to clipboard">
19
20 <meta name="lang:search.language" content="en">
21
22 <meta name="lang:search.pipeline.stopwords" content="True">
23
24 <meta name="lang:search.pipeline.trimmer" content="True">
25
26 <meta name="lang:search.result.none" content="No matching documents">
27
28 <meta name="lang:search.result.one" content="1 matching document">
29
30 <meta name="lang:search.result.other" content="# matching documents">
31
32 <meta name="lang:search.tokenizer" content="[\s\-]+">
33
34 <link rel="shortcut icon" href="../../assets/images/favicon.png">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]35 <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.3">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]36
37
38
39 <title>Using `dippy-bird` - Team Bliss</title>
40
41
42
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]43 <link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]44
45
46
47
48 <script src="../../assets/javascripts/modernizr.74668098.js"></script>
49
50
51
52 <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
53 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback">
54 <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
55
56
57 <link rel="stylesheet" href="../../assets/fonts/material-icons.css">
58
59
60
61
62
63
64 </head>
65
66 <body dir="ltr">
67
68 <svg class="md-svg">
69 <defs>
70
71
72 </defs>
73 </svg>
74 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
75 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
76 <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
77
78 <a href="#using-dippy-bird" tabindex="1" class="md-skip">
79 Skip to content
80 </a>
81
82
83 <header class="md-header" data-md-component="header">
84 <nav class="md-header-nav md-grid">
85 <div class="md-flex">
86 <div class="md-flex__cell md-flex__cell--shrink">
87 <a href="../.." title="Team Bliss" class="md-header-nav__button md-logo">
88
89 <i class="md-icon"></i>
90
91 </a>
92 </div>
93 <div class="md-flex__cell md-flex__cell--shrink">
94 <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
95 </div>
96 <div class="md-flex__cell md-flex__cell--stretch">
97 <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
98
99 <span class="md-header-nav__topic">
100 Team Bliss
101 </span>
102 <span class="md-header-nav__topic">
103
104 Using `dippy-bird`
105
106 </span>
107
108 </div>
109 </div>
110 <div class="md-flex__cell md-flex__cell--shrink">
111
112 <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
113
114<div class="md-search" data-md-component="search" role="dialog">
115 <label class="md-search__overlay" for="__search"></label>
116 <div class="md-search__inner" role="search">
117 <form class="md-search__form" name="search">
118 <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
119 <label class="md-icon md-search__icon" for="__search"></label>
120 <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
121 &#xE5CD;
122 </button>
123 </form>
124 <div class="md-search__output">
125 <div class="md-search__scrollwrap" data-md-scrollfix>
126 <div class="md-search-result" data-md-component="result">
127 <div class="md-search-result__meta">
128 Type to start searching
129 </div>
130 <ol class="md-search-result__list"></ol>
131 </div>
132 </div>
133 </div>
134 </div>
135</div>
136
137 </div>
138
139 </div>
140 </nav>
141</header>
142
143 <div class="md-container">
144
145
146
147
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]148 <main class="md-main" role="main">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]149 <div class="md-main__inner md-grid" data-md-component="container">
150
151
152 <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
153 <div class="md-sidebar__scrollwrap">
154 <div class="md-sidebar__inner">
155 <nav class="md-nav md-nav--primary" data-md-level="0">
156 <label class="md-nav__title md-nav__title--site" for="__drawer">
157 <a href="../.." title="Team Bliss" class="md-nav__button md-logo">
158
159 <i class="md-icon"></i>
160
161 </a>
162 Team Bliss
163 </label>
164
165 <ul class="md-nav__list" data-md-scrollfix>
166
167
168
169
170
171
172 <li class="md-nav__item">
Eric Park5e3a1012019-08-12 13:17:03 +0800[diff] [blame]173 <a href="../.." title="Home" class="md-nav__link">
174 Home
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]175 </a>
176 </li>
177
178
179
180
181
182
183
184 <li class="md-nav__item md-nav__item--nested">
185
186 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">
187
188 <label class="md-nav__link" for="nav-2">
189 Bliss OS
190 </label>
191 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
192 <label class="md-nav__title" for="nav-2">
193 Bliss OS
194 </label>
195 <ul class="md-nav__list" data-md-scrollfix>
196
197
198
199
200
201
202
203 <li class="md-nav__item">
204 <a href="../../Bliss OS/" title="Index" class="md-nav__link">
205 Index
206 </a>
207 </li>
208
209
210
211
212
213
214
215 <li class="md-nav__item">
Eric Park5e3a1012019-08-12 13:17:03 +0800[diff] [blame]216 <a href="../../Bliss OS/build-guide/" title="Build Guide" class="md-nav__link">
217 Build Guide
218 </a>
219 </li>
220
221
222
223
224
225
226
227 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]228 <a href="../../Bliss OS/extras/" title="Extras" class="md-nav__link">
229 Extras
230 </a>
231 </li>
232
233
234
235
236
237
238
239 <li class="md-nav__item">
Eric Parkd09b00e2020-02-15 11:07:48 +0900[diff] [blame]240 <a href="../../Bliss OS/installation-guide-misc/" title="Installation Guide (Misc)" class="md-nav__link">
241 Installation Guide (Misc)
242 </a>
243 </li>
244
245
246
247
248
249
250
251 <li class="md-nav__item">
252 <a href="../../Bliss OS/installation-guide-surface-devices/" title="Installation Guide (Surface devices)" class="md-nav__link">
253 Installation Guide (Surface devices)
254 </a>
255 </li>
256
257
258
259
260
261
262
263 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]264 <a href="../../Bliss OS/installation-guide/" title="Installation Guide" class="md-nav__link">
265 Installation Guide
266 </a>
267 </li>
268
269
270
271
272
273
274
275 <li class="md-nav__item">
Eric Park0509f652020-03-01 01:54:39 +0900[diff] [blame]276 <a href="../../Bliss OS/taking-bug-reports/" title="Taking bug reports" class="md-nav__link">
277 Taking bug reports
278 </a>
279 </li>
280
281
282
283
284
285
286
287 <li class="md-nav__item">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]288 <a href="../../Bliss OS/troubleshooting/" title="Troubleshooting" class="md-nav__link">
289 Troubleshooting
290 </a>
291 </li>
292
293
294 </ul>
295 </nav>
296 </li>
297
298
299
300
301
302
303
304 <li class="md-nav__item md-nav__item--nested">
305
306 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
307
308 <label class="md-nav__link" for="nav-3">
309 BlissRoms
310 </label>
311 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
312 <label class="md-nav__title" for="nav-3">
313 BlissRoms
314 </label>
315 <ul class="md-nav__list" data-md-scrollfix>
316
317
318
319
320
321
322
323 <li class="md-nav__item">
324 <a href="../../BlissRoms/" title="Index" class="md-nav__link">
325 Index
326 </a>
327 </li>
328
329
330
331
332
333
334
335 <li class="md-nav__item">
336 <a href="../../BlissRoms/build-guide/" title="Build Guide" class="md-nav__link">
337 Build Guide
338 </a>
339 </li>
340
341
342
343
344
345
346
347 <li class="md-nav__item">
348 <a href="../../BlissRoms/build-tips/" title="Build Tips" class="md-nav__link">
349 Build Tips
350 </a>
351 </li>
352
353
354 </ul>
355 </nav>
356 </li>
357
358
359
360
361
362
363
364
365
366 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
367
368 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked>
369
370 <label class="md-nav__link" for="nav-4">
371 Common
372 </label>
373 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
374 <label class="md-nav__title" for="nav-4">
375 Common
376 </label>
377 <ul class="md-nav__list" data-md-scrollfix>
378
379
380
381
382
383
384
385 <li class="md-nav__item">
386 <a href="../" title="Index" class="md-nav__link">
387 Index
388 </a>
389 </li>
390
391
392
393
394
395
396
397 <li class="md-nav__item">
398 <a href="../git-started/" title="Git Started" class="md-nav__link">
399 Git Started
400 </a>
401 </li>
402
403
404
405
406
407
Eric Park8584eda2019-09-02 09:45:55 +0800[diff] [blame]408
409 <li class="md-nav__item">
410 <a href="../maintaining-proper-authorship/" title="Maintaining proper authorship" class="md-nav__link">
411 Maintaining proper authorship
412 </a>
413 </li>
414
415
416
417
418
419
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]420
421
422
423 <li class="md-nav__item md-nav__item--active">
424
425 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
426
427
428
429
430 <label class="md-nav__link md-nav__link--active" for="__toc">
431 Using `dippy-bird`
432 </label>
433
434 <a href="./" title="Using `dippy-bird`" class="md-nav__link md-nav__link--active">
435 Using `dippy-bird`
436 </a>
437
438
439<nav class="md-nav md-nav--secondary">
440
441
442
443
444
445 <label class="md-nav__title" for="__toc">Table of contents</label>
446 <ul class="md-nav__list" data-md-scrollfix>
447
448 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]449 <a href="#installation" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]450 Installation
451 </a>
452
453</li>
454
455 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]456 <a href="#usage" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]457 Usage
458 </a>
459
460 <nav class="md-nav">
461 <ul class="md-nav__list">
462
463 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]464 <a href="#reviewing-commits-code-review-only" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]465 Reviewing commits (code-review only)
466 </a>
467
468</li>
469
470 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]471 <a href="#reviewing-commits-code-review-and-verification" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]472 Reviewing commits (code-review and verification)
473 </a>
474
475</li>
476
Eric Park847635a2019-10-21 14:42:24 +0800[diff] [blame]477 <li class="md-nav__item">
478 <a href="#submitting-commits-admins-only" class="md-nav__link">
479 Submitting commits (admins only)
480 </a>
481
482</li>
483
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]484 </ul>
485 </nav>
486
487</li>
488
489
490
491
492
493 </ul>
494
495</nav>
496
497 </li>
498
499
500 </ul>
501 </nav>
502 </li>
503
504
505
506
507
508
509
510 <li class="md-nav__item md-nav__item--nested">
511
512 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
513
514 <label class="md-nav__link" for="nav-5">
515 Infrastructure
516 </label>
517 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
518 <label class="md-nav__title" for="nav-5">
519 Infrastructure
520 </label>
521 <ul class="md-nav__list" data-md-scrollfix>
522
523
524
525
526
527
528
529 <li class="md-nav__item">
530 <a href="../../infrastructure/" title="Index" class="md-nav__link">
531 Index
532 </a>
533 </li>
534
535
536 </ul>
537 </nav>
538 </li>
539
540
541 </ul>
542</nav>
543 </div>
544 </div>
545 </div>
546
547
548 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
549 <div class="md-sidebar__scrollwrap">
550 <div class="md-sidebar__inner">
551
552<nav class="md-nav md-nav--secondary">
553
554
555
556
557
558 <label class="md-nav__title" for="__toc">Table of contents</label>
559 <ul class="md-nav__list" data-md-scrollfix>
560
561 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]562 <a href="#installation" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]563 Installation
564 </a>
565
566</li>
567
568 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]569 <a href="#usage" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]570 Usage
571 </a>
572
573 <nav class="md-nav">
574 <ul class="md-nav__list">
575
576 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]577 <a href="#reviewing-commits-code-review-only" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]578 Reviewing commits (code-review only)
579 </a>
580
581</li>
582
583 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]584 <a href="#reviewing-commits-code-review-and-verification" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]585 Reviewing commits (code-review and verification)
586 </a>
587
588</li>
589
Eric Park847635a2019-10-21 14:42:24 +0800[diff] [blame]590 <li class="md-nav__item">
591 <a href="#submitting-commits-admins-only" class="md-nav__link">
592 Submitting commits (admins only)
593 </a>
594
595</li>
596
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]597 </ul>
598 </nav>
599
600</li>
601
602
603
604
605
606 </ul>
607
608</nav>
609 </div>
610 </div>
611 </div>
612
613
614 <div class="md-content">
615 <article class="md-content__inner md-typeset">
616
617
618
619 <h1 id="using-dippy-bird">Using <code>dippy-bird</code></h1>
620<p>If you want to review commits quickly on our Gerrit, <a href="https://github.com/wikimedia/mediawiki-tools-dippybird/blob/master/dippy-bird.php">use the <code>dippy-bird.php</code> script created by the WikiMedia foundation.</a></p>
621<p>Thanks to Vaughn Newman (@rwaterspf1) for the original instructions!</p>
622<h2 id="installation">Installation</h2>
623<p>Make sure you have PHP installed.</p>
624<p><a href="https://github.com/wikimedia/mediawiki-tools-dippybird/blob/master/dippy-bird.php">Download the script</a> and put it in an easily-accessible place.</p>
625<h2 id="usage">Usage</h2>
626<h3 id="reviewing-commits-code-review-only">Reviewing commits (code-review only)</h3>
627<p>To review commits, run:</p>
628<pre><code>php dippy-bird.php --username=ideaman924 --server=review.blissroms.com --port=29418 -q="status:open topic:test" -a=review --review=+1 --verify=0
629</code></pre>
630<p>This will review all commits that match the following criteria:</p>
631<ul>
632<li>Is open for review (not closed, merged, or abandoned)</li>
633<li>Has the topic <code>test</code></li>
634</ul>
635<p>And will apply +1 code-review and no verify, indicating that you have a successful build with the commits included.</p>
636<h3 id="reviewing-commits-code-review-and-verification">Reviewing commits (code-review and verification)</h3>
637<p>To review commits with verification, run:</p>
638<pre><code>php dippy-bird.php --username=ideaman924 --server=review.blissroms.com --port=29418 -q="status:open topic:test" -a=review --review=+2 --verify=+1
639</code></pre>
640<p>This will review all commits that match the following criteria:</p>
641<ul>
642<li>Is open for review (not closed, merged, or abandoned)</li>
643<li>Has the topic <code>test</code></li>
644</ul>
645<p>And will apply +2 code-review and +1 verify, indicating that you have tested the commits on an actual device. This means that the commits are now ready for merging.</p>
Eric Park847635a2019-10-21 14:42:24 +0800[diff] [blame]646<h3 id="submitting-commits-admins-only">Submitting commits (admins only)</h3>
647<p>To submit commits that are already reviewed, run:</p>
648<pre><code>php dippy-bird.php --username=jackeagle --server=review.blissroms.com --port=29418 -q="status:open topic:test" -a=submit
649</code></pre>
650<p>This will submit all commits that match the following criteria:</p>
651<ul>
652<li>Is open for review (not closed, merged, or abandoned)</li>
653<li>Has the topic <code>test</code></li>
654</ul>
655<p>And will push them to our main GitHub. If the commits are not reviewed yet, or if they do not have the verified tag, this command will fail for the patchsets that are not reviewed yet. Other commits will still be merged.</p>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]656
657
658
659
660
661
662
663
664
665 </article>
666 </div>
667 </div>
668 </main>
669
670
671<footer class="md-footer">
672
673 <div class="md-footer-nav">
674 <nav class="md-footer-nav__inner md-grid">
675
Eric Park8584eda2019-09-02 09:45:55 +0800[diff] [blame]676 <a href="../maintaining-proper-authorship/" title="Maintaining proper authorship" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]677 <div class="md-flex__cell md-flex__cell--shrink">
678 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
679 </div>
680 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
681 <span class="md-flex__ellipsis">
682 <span class="md-footer-nav__direction">
683 Previous
684 </span>
Eric Park8584eda2019-09-02 09:45:55 +0800[diff] [blame]685 Maintaining proper authorship
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]686 </span>
687 </div>
688 </a>
689
690
691 <a href="../../infrastructure/" title="Index" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
692 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
693 <span class="md-flex__ellipsis">
694 <span class="md-footer-nav__direction">
695 Next
696 </span>
697 Index
698 </span>
699 </div>
700 <div class="md-flex__cell md-flex__cell--shrink">
701 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
702 </div>
703 </a>
704
705 </nav>
706 </div>
707
708 <div class="md-footer-meta md-typeset">
709 <div class="md-footer-meta__inner md-grid">
710 <div class="md-footer-copyright">
711
712 powered by
713 <a href="https://www.mkdocs.org">MkDocs</a>
714 and
715 <a href="https://squidfunk.github.io/mkdocs-material/">
716 Material for MkDocs</a>
717 </div>
718
719 </div>
720 </div>
721</footer>
722
723 </div>
724
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]725 <script src="../../assets/javascripts/application.ac79c3b0.js"></script>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]726
727 <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
728
729
730 </body>
731</html>