Gitiles
Code Review Sign In
review.blissroms.org / Documentation-release / 5e3a101ae14d3f8fd12fec6fd6e71dbd9c2a4e99 / . / common / using-dippy-bird / index.html
blob: 0daed6ac8f5971749595b6d615b4dd8dff59ac61 [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
372
373
374
375 <li class="md-nav__item md-nav__item--active">
376
377 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
378
379
380
381
382 <label class="md-nav__link md-nav__link--active" for="__toc">
383 Using `dippy-bird`
384 </label>
385
386 <a href="./" title="Using `dippy-bird`" class="md-nav__link md-nav__link--active">
387 Using `dippy-bird`
388 </a>
389
390
391<nav class="md-nav md-nav--secondary">
392
393
394
395
396
397 <label class="md-nav__title" for="__toc">Table of contents</label>
398 <ul class="md-nav__list" data-md-scrollfix>
399
400 <li class="md-nav__item">
401 <a href="#installation" title="Installation" class="md-nav__link">
402 Installation
403 </a>
404
405</li>
406
407 <li class="md-nav__item">
408 <a href="#usage" title="Usage" class="md-nav__link">
409 Usage
410 </a>
411
412 <nav class="md-nav">
413 <ul class="md-nav__list">
414
415 <li class="md-nav__item">
416 <a href="#reviewing-commits-code-review-only" title="Reviewing commits (code-review only)" class="md-nav__link">
417 Reviewing commits (code-review only)
418 </a>
419
420</li>
421
422 <li class="md-nav__item">
423 <a href="#reviewing-commits-code-review-and-verification" title="Reviewing commits (code-review and verification)" class="md-nav__link">
424 Reviewing commits (code-review and verification)
425 </a>
426
427</li>
428
429 </ul>
430 </nav>
431
432</li>
433
434
435
436
437
438 </ul>
439
440</nav>
441
442 </li>
443
444
445 </ul>
446 </nav>
447 </li>
448
449
450
451
452
453
454
455 <li class="md-nav__item md-nav__item--nested">
456
457 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
458
459 <label class="md-nav__link" for="nav-5">
460 Infrastructure
461 </label>
462 <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
463 <label class="md-nav__title" for="nav-5">
464 Infrastructure
465 </label>
466 <ul class="md-nav__list" data-md-scrollfix>
467
468
469
470
471
472
473
474 <li class="md-nav__item">
475 <a href="../../infrastructure/" title="Index" class="md-nav__link">
476 Index
477 </a>
478 </li>
479
480
481 </ul>
482 </nav>
483 </li>
484
485
486 </ul>
487</nav>
488 </div>
489 </div>
490 </div>
491
492
493 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
494 <div class="md-sidebar__scrollwrap">
495 <div class="md-sidebar__inner">
496
497<nav class="md-nav md-nav--secondary">
498
499
500
501
502
503 <label class="md-nav__title" for="__toc">Table of contents</label>
504 <ul class="md-nav__list" data-md-scrollfix>
505
506 <li class="md-nav__item">
507 <a href="#installation" title="Installation" class="md-nav__link">
508 Installation
509 </a>
510
511</li>
512
513 <li class="md-nav__item">
514 <a href="#usage" title="Usage" class="md-nav__link">
515 Usage
516 </a>
517
518 <nav class="md-nav">
519 <ul class="md-nav__list">
520
521 <li class="md-nav__item">
522 <a href="#reviewing-commits-code-review-only" title="Reviewing commits (code-review only)" class="md-nav__link">
523 Reviewing commits (code-review only)
524 </a>
525
526</li>
527
528 <li class="md-nav__item">
529 <a href="#reviewing-commits-code-review-and-verification" title="Reviewing commits (code-review and verification)" class="md-nav__link">
530 Reviewing commits (code-review and verification)
531 </a>
532
533</li>
534
535 </ul>
536 </nav>
537
538</li>
539
540
541
542
543
544 </ul>
545
546</nav>
547 </div>
548 </div>
549 </div>
550
551
552 <div class="md-content">
553 <article class="md-content__inner md-typeset">
554
555
556
557 <h1 id="using-dippy-bird">Using <code>dippy-bird</code></h1>
558<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>
559<p>Thanks to Vaughn Newman (@rwaterspf1) for the original instructions!</p>
560<h2 id="installation">Installation</h2>
561<p>Make sure you have PHP installed.</p>
562<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>
563<h2 id="usage">Usage</h2>
564<h3 id="reviewing-commits-code-review-only">Reviewing commits (code-review only)</h3>
565<p>To review commits, run:</p>
566<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
567</code></pre>
568<p>This will review all commits that match the following criteria:</p>
569<ul>
570<li>Is open for review (not closed, merged, or abandoned)</li>
571<li>Has the topic <code>test</code></li>
572</ul>
573<p>And will apply +1 code-review and no verify, indicating that you have a successful build with the commits included.</p>
574<h3 id="reviewing-commits-code-review-and-verification">Reviewing commits (code-review and verification)</h3>
575<p>To review commits with verification, run:</p>
576<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
577</code></pre>
578<p>This will review all commits that match the following criteria:</p>
579<ul>
580<li>Is open for review (not closed, merged, or abandoned)</li>
581<li>Has the topic <code>test</code></li>
582</ul>
583<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>
584
585
586
587
588
589
590
591
592
593 </article>
594 </div>
595 </div>
596 </main>
597
598
599<footer class="md-footer">
600
601 <div class="md-footer-nav">
602 <nav class="md-footer-nav__inner md-grid">
603
604 <a href="../git-started/" title="Git Started" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
605 <div class="md-flex__cell md-flex__cell--shrink">
606 <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
607 </div>
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 Previous
612 </span>
613 Git Started
614 </span>
615 </div>
616 </a>
617
618
619 <a href="../../infrastructure/" title="Index" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
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 Next
624 </span>
625 Index
626 </span>
627 </div>
628 <div class="md-flex__cell md-flex__cell--shrink">
629 <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
630 </div>
631 </a>
632
633 </nav>
634 </div>
635
636 <div class="md-footer-meta md-typeset">
637 <div class="md-footer-meta__inner md-grid">
638 <div class="md-footer-copyright">
639
640 powered by
641 <a href="https://www.mkdocs.org">MkDocs</a>
642 and
643 <a href="https://squidfunk.github.io/mkdocs-material/">
644 Material for MkDocs</a>
645 </div>
646
647 </div>
648 </div>
649</footer>
650
651 </div>
652
653 <script src="../../assets/javascripts/application.245445c6.js"></script>
654
655 <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
656
657
658 </body>
659</html>