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