Gitiles
Code Review Sign In
review.blissroms.org / Documentation-release / 8584edae205cb7f7b7652e72000f057281af161c / . / common / using-dippy-bird / index.html
blob: 85203f1542f9de3c0a1ca100f21b2c325b5bf975 [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">
35 <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.0">
36
37
38
39 <title>Using `dippy-bird` - Team Bliss</title>
40
41
42
43 <link rel="stylesheet" href="../../assets/stylesheets/application.0284f74d.css">
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
148 <main class="md-main">
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">
413 <a href="#installation" title="Installation" class="md-nav__link">
414 Installation
415 </a>
416
417</li>
418
419 <li class="md-nav__item">
420 <a href="#usage" title="Usage" class="md-nav__link">
421 Usage
422 </a>
423
424 <nav class="md-nav">
425 <ul class="md-nav__list">
426
427 <li class="md-nav__item">
428 <a href="#reviewing-commits-code-review-only" title="Reviewing commits (code-review only)" class="md-nav__link">
429 Reviewing commits (code-review only)
430 </a>
431
432</li>
433
434 <li class="md-nav__item">
435 <a href="#reviewing-commits-code-review-and-verification" title="Reviewing commits (code-review and verification)" class="md-nav__link">
436 Reviewing commits (code-review and verification)
437 </a>
438
439</li>
440
441 </ul>
442 </nav>
443
444</li>
445
446
447
448
449
450 </ul>
451
452</nav>
453
454 </li>
455
456
457 </ul>
458 </nav>
459 </li>
460
461
462
463
464
465
466
467 <li class="md-nav__item md-nav__item--nested">
468
469 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
470
471 <label class="md-nav__link" for="nav-5">
472 Infrastructure
473 </label>
474 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
475 <label class="md-nav__title" for="nav-5">
476 Infrastructure
477 </label>
478 <ul class="md-nav__list" data-md-scrollfix>
479
480
481
482
483
484
485
486 <li class="md-nav__item">
487 <a href="../../infrastructure/" title="Index" class="md-nav__link">
488 Index
489 </a>
490 </li>
491
492
493 </ul>
494 </nav>
495 </li>
496
497
498 </ul>
499</nav>
500 </div>
501 </div>
502 </div>
503
504
505 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
506 <div class="md-sidebar__scrollwrap">
507 <div class="md-sidebar__inner">
508
509<nav class="md-nav md-nav--secondary">
510
511
512
513
514
515 <label class="md-nav__title" for="__toc">Table of contents</label>
516 <ul class="md-nav__list" data-md-scrollfix>
517
518 <li class="md-nav__item">
519 <a href="#installation" title="Installation" class="md-nav__link">
520 Installation
521 </a>
522
523</li>
524
525 <li class="md-nav__item">
526 <a href="#usage" title="Usage" class="md-nav__link">
527 Usage
528 </a>
529
530 <nav class="md-nav">
531 <ul class="md-nav__list">
532
533 <li class="md-nav__item">
534 <a href="#reviewing-commits-code-review-only" title="Reviewing commits (code-review only)" class="md-nav__link">
535 Reviewing commits (code-review only)
536 </a>
537
538</li>
539
540 <li class="md-nav__item">
541 <a href="#reviewing-commits-code-review-and-verification" title="Reviewing commits (code-review and verification)" class="md-nav__link">
542 Reviewing commits (code-review and verification)
543 </a>
544
545</li>
546
547 </ul>
548 </nav>
549
550</li>
551
552
553
554
555
556 </ul>
557
558</nav>
559 </div>
560 </div>
561 </div>
562
563
564 <div class="md-content">
565 <article class="md-content__inner md-typeset">
566
567
568
569 <h1 id="using-dippy-bird">Using <code>dippy-bird</code></h1>
570<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>
571<p>Thanks to Vaughn Newman (@rwaterspf1) for the original instructions!</p>
572<h2 id="installation">Installation</h2>
573<p>Make sure you have PHP installed.</p>
574<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>
575<h2 id="usage">Usage</h2>
576<h3 id="reviewing-commits-code-review-only">Reviewing commits (code-review only)</h3>
577<p>To review commits, run:</p>
578<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
579</code></pre>
580<p>This will review all commits that match the following criteria:</p>
581<ul>
582<li>Is open for review (not closed, merged, or abandoned)</li>
583<li>Has the topic <code>test</code></li>
584</ul>
585<p>And will apply +1 code-review and no verify, indicating that you have a successful build with the commits included.</p>
586<h3 id="reviewing-commits-code-review-and-verification">Reviewing commits (code-review and verification)</h3>
587<p>To review commits with verification, run:</p>
588<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
589</code></pre>
590<p>This will review all commits that match the following criteria:</p>
591<ul>
592<li>Is open for review (not closed, merged, or abandoned)</li>
593<li>Has the topic <code>test</code></li>
594</ul>
595<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>
596
597
598
599
600
601
602
603
604
605 </article>
606 </div>
607 </div>
608 </main>
609
610
611<footer class="md-footer">
612
613 <div class="md-footer-nav">
614 <nav class="md-footer-nav__inner md-grid">
615
Eric Park8584eda2019-09-02 09:45:55 +0800[diff] [blame^]616 <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]617 <div class="md-flex__cell md-flex__cell--shrink">
618 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
619 </div>
620 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
621 <span class="md-flex__ellipsis">
622 <span class="md-footer-nav__direction">
623 Previous
624 </span>
Eric Park8584eda2019-09-02 09:45:55 +0800[diff] [blame^]625 Maintaining proper authorship
Eric Park608ce5a2019-08-07 21:27:46 +0800[diff] [blame]626 </span>
627 </div>
628 </a>
629
630
631 <a href="../../infrastructure/" title="Index" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
632 <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
633 <span class="md-flex__ellipsis">
634 <span class="md-footer-nav__direction">
635 Next
636 </span>
637 Index
638 </span>
639 </div>
640 <div class="md-flex__cell md-flex__cell--shrink">
641 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
642 </div>
643 </a>
644
645 </nav>
646 </div>
647
648 <div class="md-footer-meta md-typeset">
649 <div class="md-footer-meta__inner md-grid">
650 <div class="md-footer-copyright">
651
652 powered by
653 <a href="https://www.mkdocs.org">MkDocs</a>
654 and
655 <a href="https://squidfunk.github.io/mkdocs-material/">
656 Material for MkDocs</a>
657 </div>
658
659 </div>
660 </div>
661</footer>
662
663 </div>
664
665 <script src="../../assets/javascripts/application.245445c6.js"></script>
666
667 <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
668
669
670 </body>
671</html>