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