19
19
< h1 > Ghurlbot manual</ h1 >
20
20
21
21
< p > Ghurlbot (< b > G</ b > it< b > H</ b > ub < b > URL</ b > ro< b > bot</ b > ) is an IRC
22
- bot that looks up GitHub issues, creates new issues
22
+ bot that looks up GitHub issues, pull requests or discussions,
23
+ creates new issues
23
24
and action items, or closes them. It typically has the nickname
24
25
‘gb’ on IRC, which is what we will use here.</ p >
25
26
@@ -50,7 +51,7 @@ <h2>Command quick reference</h2>
50
51
aria#15< br >
51
52
#15</ code > </ td >
52
53
< td > < a href ="#info "> Look up an issue (which may also be a pull
53
- request or an action)</ a > </ td >
54
+ request, an action or a discussion )</ a > </ td >
54
55
</ tr >
55
56
< tr >
56
57
< td class =command > < code > @joe</ code > </ td >
@@ -86,15 +87,18 @@ <h2>Command quick reference</h2>
86
87
</ tr >
87
88
< tr >
88
89
< td class =command > < code > close #15</ code > </ td >
89
- < td > < a href ="#close "> Close an issue or action</ a > </ td >
90
+ < td > < a href ="#close "> Close an issue, action, pull request or
91
+ discussion</ a > </ td >
90
92
</ tr >
91
93
< tr >
92
94
< td class =command > < code > reopen aria/#15</ code > </ td >
93
- < td > < a href ="#reopen "> Reopen an issue or action</ a > </ td >
95
+ < td > < a href ="#reopen "> Reopen an issue, action, pull request or
96
+ discussion</ a > </ td >
94
97
</ tr >
95
98
< tr >
96
99
< td class =command > < code > Note #17 This needs work</ code > </ td >
97
- < td > < a href ="#comment "> Add a comment to an issue</ a > </ td >
100
+ < td > < a href ="#comment "> Add a comment to an issue, action, pull
101
+ request or discussion</ a > </ td >
98
102
</ tr >
99
103
< tr >
100
104
< td class =command > < code > gb, list open issues with label foo</ code >
@@ -113,7 +117,8 @@ <h2>Command quick reference</h2>
113
117
< td class =command > < code > gb, off< br >
114
118
gb, on</ code > </ td >
115
119
< td > < a href ="#suspend "> Stop gb from processing issues,
116
- actions and names; or turn it back on</ a > </ td >
120
+ actions, pull requests, discussions & names; or turn it back
121
+ on</ a > </ td >
117
122
</ tr >
118
123
< tr >
119
124
< td class =command > < code > gb, names off< br >
@@ -124,23 +129,24 @@ <h2>Command quick reference</h2>
124
129
< tr >
125
130
< td class =command > < code > gb, issues off< br >
126
131
gb, issues on</ code > </ td >
127
- < td > < a href ="#suspend "> Stop gb from processing issues
128
- and actions; or turn it back on</ a > </ td >
132
+ < td > < a href ="#suspend "> Stop gb from processing issues,
133
+ actions, pull requests & discussions; or turn it back
134
+ on</ a > </ td >
129
135
</ tr >
130
136
< tr >
131
137
< td class =command > < code > gb, delay 20</ code > </ td >
132
138
< td > < a href ="#delay "> Set the number of lines before gb
133
- looks up the same issue or name again </ a > </ td >
139
+ looks up the same issue number </ a > </ td >
134
140
</ tr >
135
141
< tr >
136
142
< td class =command > < code > gb, ignore RRSAgent, Zakim</ code > </ td >
137
- < td > < a href ="#ignore "> Nicks that cannot open or close issues
138
- & actions </ a > </ td >
143
+ < td > < a href ="#ignore "> Nicks that cannot open or close issues,
144
+ actions, pull requests & discussions </ a > </ td >
139
145
</ tr >
140
146
< tr >
141
147
< td class =command > < code > gb, don't ignore Zakim</ code > </ td >
142
- < td > < a href ="#ignore "> Let Zakim open/close issues & actions
143
- again</ a > </ td >
148
+ < td > < a href ="#ignore "> Let Zakim open/close issues, actions,
149
+ pull requests & discussions again</ a > </ td >
144
150
</ tr >
145
151
< tr >
146
152
< td class =command > < code > gb, Eve = eve78< br >
@@ -172,7 +178,8 @@ <h2 id=info>IRC command to link to an issue</h2>
172
178
173
179
< p > When somebody types something that looks like a repository name
174
180
followed by < code > #</ code > and an issue number, gb responds
175
- with the full URL of that issue or pull request:</ p >
181
+ with the full URL of that issue, action item, pull request or
182
+ discussion:</ p >
176
183
177
184
< pre class =command > <joe> Let's talk about foo/bar#13.
178
185
<gb> https://github.com/foo/bar/issues/13 -> #13</ pre >
@@ -190,8 +197,9 @@ <h2 id=info>IRC command to link to an issue</h2>
190
197
191
198
< p > Gb fails to look up an issue if it does not have access to
192
199
a GitHub account or if the issue is in a private repository,
193
- see < a href ="#account " > ‘GitHub account’</ a > . (Gb may also
194
- fail due to network problems.)</ p >
200
+ see < a href ="#account " > ‘GitHub account’</ a > . Gb may also
201
+ fail due to network problems. In these cases the URL is unverified
202
+ and may be wrong.</ p >
195
203
196
204
< p id =abbreviate > If you have told gb what repositories you are
197
205
discussing
@@ -230,8 +238,9 @@ <h2 id=info>IRC command to link to an issue</h2>
230
238
231
239
< h2 id =url > Look up an issue by its URL</ h2 >
232
240
233
- < p > When gb sees a URL that looks like the URL of an issue on GitHub,
234
- it will try to retrieve a summary of that issue from GitHub. E.g.:
241
+ < p > When gb sees a URL that looks like the URL of an issue, pull
242
+ request or discussion on GitHub, it will try to retrieve its
243
+ summary from GitHub. E.g.:
235
244
236
245
< pre class =command > <joe> topic: https://github.com/w3c/scribe2/issues/15
237
246
<gb> https://github.com/w3c/scribe2/issues/15 -> CLOSED Issue 15 Feature request: syntax for verbatim lines of code (by dbooth-boston)</ pre >
@@ -274,7 +283,8 @@ <h2 id=ignore>Text that gb ignores</h2>
274
283
275
284
< h2 id =repo > Specifying the GitHub repository</ h2 >
276
285
277
- < p > To be able to refer to issues and pull requests with the
286
+ < p > To be able to refer to issues, actions, pull requests and
287
+ discussions with the
278
288
abbreviated syntax, you need to say what repository is being
279
289
discussed on this channel:</ p >
280
290
@@ -385,9 +395,10 @@ <h2 id=create-action>Creating an action</h2>
385
395
< p > Many different ways of describing a date are supported, including
386
396
things like ‘in 2 weeks’, ‘tomorrow’ and ‘next Tuesday’.</ p >
387
397
388
- < h2 id =close > Closing an issue or action </ h2 >
398
+ < h2 id =close > Closing an issue</ h2 >
389
399
390
- < p > You can close an issue or action by starting a line
400
+ < p > You can close an issue, action, pull request or discussion by
401
+ starting a line
391
402
with < code > close</ code > , followed by an issue number or a URL,
392
403
e.g.:</ p >
393
404
@@ -401,9 +412,10 @@ <h2 id=close>Closing an issue or action</h2>
401
412
abbreviation, see < a href ="#info " > ‘IRC command to link to an
402
413
issue: #’</ a > .
403
414
404
- < h2 id =reopen > Reopening an issue or action </ h2 >
415
+ < h2 id =reopen > Reopening an issue</ h2 >
405
416
406
- < p > You can reopen an issue or action by starting a line
417
+ < p > You can reopen an issue, action, pull request or discussion by
418
+ starting a line
407
419
with < code > reopen</ code > , followed by an issue number or a URL,
408
420
e.g.:</ p >
409
421
@@ -451,7 +463,8 @@ <h2 id=action-format>Creating & editing actions without Gb</h2>
451
463
452
464
< h2 id =comment > Adding a comment to an issue</ h2 >
453
465
454
- < p > You can add a comment to an existing issue, with
466
+ < p > You can add a comment to an existing issue, action, pull request
467
+ or discussion, with
455
468
commands < code > note</ code > and < code > comment</ code > , like
456
469
this:</ p >
457
470
@@ -549,13 +562,12 @@ <h2 id=maxlines>Setting the number of full issues to display</h2>
549
562
the number of lines per second, listing 10 issues already takes
550
563
about 23 seconds.</ p >
551
564
552
- < h2 id =ignore > IRC nicks that should not open or close issues &
553
- actions</ h2 >
565
+ < h2 id =ignore > IRC nicks that should not open or close issues</ h2 >
554
566
555
567
< p > Certain IRC bots may print text that looks like an action or an
556
568
issue, but isn't really. E.g., RRSAgent repeats all actions at the
557
569
end of a meeting. To stop such bots from inadvertently opening or
558
- closing issues and actions, you can add their name to an ignore
570
+ closing issues and actions, you can add their names to an ignore
559
571
list:
560
572
561
573
< pre class =command > <joe> gb, ignore RRSAgent</ pre >
@@ -612,7 +624,8 @@ <h2 id=invite>Inviting and dismissing the bot</h2>
612
624
613
625
< h2 id =suspend > Suspending the bot</ h2 >
614
626
615
- < p > You can tell the bot to stop processing issues, actions and names
627
+ < p > You can tell the bot to stop processing issues, actions, pull
628
+ request, discussion and names
616
629
without dismissing it from the channel; and turn it back on
617
630
again:</ p >
618
631
@@ -629,7 +642,7 @@ <h2 id=suspend>Suspending the bot</h2>
629
642
or < code > false</ code > . And instead of < code > names</ code > you can
630
643
also use < code > persons</ code > or < code > teams</ code > .</ p >
631
644
632
- < p > To ask it to stop processing just issues, pull requests and
645
+ < p > To ask it to stop processing just issues, pull requests, discussions and
633
646
actions, the command is:</ p >
634
647
635
648
< pre class =command > <joe> gb, set issues to off
0 commit comments