Gitiles
Code Review Sign In
review.blissroms.org / Documentation-release / 30fb8399ae4737dfa1043a99c4b8092a844123c1 / . / common / using-dippy-bird / index.html
blob: 12fec33f513c8ae3b1334a6d7b658cc746d9a40d [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">
240 <a href="../../Bliss OS/installation-guide/" title="Installation Guide" class="md-nav__link">
241 Installation Guide
242 </a>
243 </li>
244
245
246
247
248
249
250
251 <li class="md-nav__item">
252 <a href="../../Bliss OS/troubleshooting/" title="Troubleshooting" class="md-nav__link">
253 Troubleshooting
254 </a>
255 </li>
256
257
258 </ul>
259 </nav>
260 </li>
261
262
263
264
265
266
267
268 <li class="md-nav__item md-nav__item--nested">
269
270 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
271
272 <label class="md-nav__link" for="nav-3">
273 BlissRoms
274 </label>
275 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
276 <label class="md-nav__title" for="nav-3">
277 BlissRoms
278 </label>
279 <ul class="md-nav__list" data-md-scrollfix>
280
281
282
283
284
285
286
287 <li class="md-nav__item">
288 <a href="../../BlissRoms/" title="Index" class="md-nav__link">
289 Index
290 </a>
291 </li>
292
293
294
295
296
297
298
299 <li class="md-nav__item">
300 <a href="../../BlissRoms/build-guide/" title="Build Guide" class="md-nav__link">
301 Build Guide
302 </a>
303 </li>
304
305
306
307
308
309
310
311 <li class="md-nav__item">
312 <a href="../../BlissRoms/build-tips/" title="Build Tips" class="md-nav__link">
313 Build Tips
314 </a>
315 </li>
316
317
318 </ul>
319 </nav>
320 </li>
321
322
323
324
325
326
327
328
329
330 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
331
332 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked>
333
334 <label class="md-nav__link" for="nav-4">
335 Common
336 </label>
337 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
338 <label class="md-nav__title" for="nav-4">
339 Common
340 </label>
341 <ul class="md-nav__list" data-md-scrollfix>
342
343
344
345
346
347
348
349 <li class="md-nav__item">
350 <a href="../" title="Index" class="md-nav__link">
351 Index
352 </a>
353 </li>
354
355
356
357
358
359
360
361 <li class="md-nav__item">
362 <a href="../git-started/" title="Git Started" class="md-nav__link">
363 Git Started
364 </a>
365 </li>
366
367
368
369
370
371
Eric Park8584eda2019-09-02 09:45:55 +0800[diff] [blame]372
373 <li class="md-nav__item">
374 <a href="../maintaining-proper-authorship/" title="Maintaining proper authorship" class="md-nav__link">
375 Maintaining proper authorship
376 </a>
377 </li>
378
379
380
381
382
383
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]384
385
386
387 <li class="md-nav__item md-nav__item--active">
388
389 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
390
391
392
393
394 <label class="md-nav__link md-nav__link--active" for="__toc">
395 Using `dippy-bird`
396 </label>
397
398 <a href="./" title="Using `dippy-bird`" class="md-nav__link md-nav__link--active">
399 Using `dippy-bird`
400 </a>
401
402
403<nav class="md-nav md-nav--secondary">
404
405
406
407
408
409 <label class="md-nav__title" for="__toc">Table of contents</label>
410 <ul class="md-nav__list" data-md-scrollfix>
411
412 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]413 <a href="#installation" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]414 Installation
415 </a>
416
417</li>
418
419 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]420 <a href="#usage" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]421 Usage
422 </a>
423
424 <nav class="md-nav">
425 <ul class="md-nav__list">
426
427 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]428 <a href="#reviewing-commits-code-review-only" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]429 Reviewing commits (code-review only)
430 </a>
431
432</li>
433
434 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]435 <a href="#reviewing-commits-code-review-and-verification" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]436 Reviewing commits (code-review and verification)
437 </a>
438
439</li>
440
Eric Park847635a2019-10-21 14:42:24 +0800[diff] [blame]441 <li class="md-nav__item">
442 <a href="#submitting-commits-admins-only" class="md-nav__link">
443 Submitting commits (admins only)
444 </a>
445
446</li>
447
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]448 </ul>
449 </nav>
450
451</li>
452
453
454
455
456
457 </ul>
458
459</nav>
460
461 </li>
462
463
464 </ul>
465 </nav>
466 </li>
467
468
469
470
471
472
473
474 <li class="md-nav__item md-nav__item--nested">
475
476 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
477
478 <label class="md-nav__link" for="nav-5">
479 Infrastructure
480 </label>
481 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
482 <label class="md-nav__title" for="nav-5">
483 Infrastructure
484 </label>
485 <ul class="md-nav__list" data-md-scrollfix>
486
487
488
489
490
491
492
493 <li class="md-nav__item">
494 <a href="../../infrastructure/" title="Index" class="md-nav__link">
495 Index
496 </a>
497 </li>
498
499
500 </ul>
501 </nav>
502 </li>
503
504
505 </ul>
506</nav>
507 </div>
508 </div>
509 </div>
510
511
512 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
513 <div class="md-sidebar__scrollwrap">
514 <div class="md-sidebar__inner">
515
516<nav class="md-nav md-nav--secondary">
517
518
519
520
521
522 <label class="md-nav__title" for="__toc">Table of contents</label>
523 <ul class="md-nav__list" data-md-scrollfix>
524
525 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]526 <a href="#installation" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]527 Installation
528 </a>
529
530</li>
531
532 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]533 <a href="#usage" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]534 Usage
535 </a>
536
537 <nav class="md-nav">
538 <ul class="md-nav__list">
539
540 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]541 <a href="#reviewing-commits-code-review-only" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]542 Reviewing commits (code-review only)
543 </a>
544
545</li>
546
547 <li class="md-nav__item">
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]548 <a href="#reviewing-commits-code-review-and-verification" class="md-nav__link">
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]549 Reviewing commits (code-review and verification)
550 </a>
551
552</li>
553
Eric Park847635a2019-10-21 14:42:24 +0800[diff] [blame]554 <li class="md-nav__item">
555 <a href="#submitting-commits-admins-only" class="md-nav__link">
556 Submitting commits (admins only)
557 </a>
558
559</li>
560
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]561 </ul>
562 </nav>
563
564</li>
565
566
567
568
569
570 </ul>
571
572</nav>
573 </div>
574 </div>
575 </div>
576
577
578 <div class="md-content">
579 <article class="md-content__inner md-typeset">
580
581
582
583 <h1 id="using-dippy-bird">Using <code>dippy-bird</code></h1>
584<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>
585<p>Thanks to Vaughn Newman (@rwaterspf1) for the original instructions!</p>
586<h2 id="installation">Installation</h2>
587<p>Make sure you have PHP installed.</p>
588<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>
589<h2 id="usage">Usage</h2>
590<h3 id="reviewing-commits-code-review-only">Reviewing commits (code-review only)</h3>
591<p>To review commits, run:</p>
592<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
593</code></pre>
594<p>This will review all commits that match the following criteria:</p>
595<ul>
596<li>Is open for review (not closed, merged, or abandoned)</li>
597<li>Has the topic <code>test</code></li>
598</ul>
599<p>And will apply +1 code-review and no verify, indicating that you have a successful build with the commits included.</p>
600<h3 id="reviewing-commits-code-review-and-verification">Reviewing commits (code-review and verification)</h3>
601<p>To review commits with verification, run:</p>
602<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
603</code></pre>
604<p>This will review all commits that match the following criteria:</p>
605<ul>
606<li>Is open for review (not closed, merged, or abandoned)</li>
607<li>Has the topic <code>test</code></li>
608</ul>
609<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]610<h3 id="submitting-commits-admins-only">Submitting commits (admins only)</h3>
611<p>To submit commits that are already reviewed, run:</p>
612<pre><code>php dippy-bird.php --username=jackeagle --server=review.blissroms.com --port=29418 -q="status:open topic:test" -a=submit
613</code></pre>
614<p>This will submit all commits that match the following criteria:</p>
615<ul>
616<li>Is open for review (not closed, merged, or abandoned)</li>
617<li>Has the topic <code>test</code></li>
618</ul>
619<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]620
621
622
623
624
625
626
627
628
629 </article>
630 </div>
631 </div>
632 </main>
633
634
635<footer class="md-footer">
636
637 <div class="md-footer-nav">
638 <nav class="md-footer-nav__inner md-grid">
639
Eric Park8584eda2019-09-02 09:45:55 +0800[diff] [blame]640 <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]641 <div class="md-flex__cell md-flex__cell--shrink">
642 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
643 </div>
644 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
645 <span class="md-flex__ellipsis">
646 <span class="md-footer-nav__direction">
647 Previous
648 </span>
Eric Park8584eda2019-09-02 09:45:55 +0800[diff] [blame]649 Maintaining proper authorship
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]650 </span>
651 </div>
652 </a>
653
654
655 <a href="../../infrastructure/" title="Index" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
656 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
657 <span class="md-flex__ellipsis">
658 <span class="md-footer-nav__direction">
659 Next
660 </span>
661 Index
662 </span>
663 </div>
664 <div class="md-flex__cell md-flex__cell--shrink">
665 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
666 </div>
667 </a>
668
669 </nav>
670 </div>
671
672 <div class="md-footer-meta md-typeset">
673 <div class="md-footer-meta__inner md-grid">
674 <div class="md-footer-copyright">
675
676 powered by
677 <a href="https://www.mkdocs.org">MkDocs</a>
678 and
679 <a href="https://squidfunk.github.io/mkdocs-material/">
680 Material for MkDocs</a>
681 </div>
682
683 </div>
684 </div>
685</footer>
686
687 </div>
688
Eric Park45174ca2019-10-21 01:38:33 +0800[diff] [blame]689 <script src="../../assets/javascripts/application.ac79c3b0.js"></script>
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]690
691 <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
692
693
694 </body>
695</html>