Skip to content

Commit 2d52099

Browse files
committed
Documented the commands that now also work for discussions.
1 parent d98c34d commit 2d52099

File tree

1 file changed

+42
-29
lines changed

1 file changed

+42
-29
lines changed

manual.html

+42-29
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
<h1>Ghurlbot manual</h1>
2020

2121
<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
2324
and action items, or closes them. It typically has the nickname
2425
‘gb’ on IRC, which is what we will use here.</p>
2526

@@ -50,7 +51,7 @@ <h2>Command quick reference</h2>
5051
aria#15<br>
5152
#15</code></td>
5253
<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>
5455
</tr>
5556
<tr>
5657
<td class=command><code>@joe</code></td>
@@ -86,15 +87,18 @@ <h2>Command quick reference</h2>
8687
</tr>
8788
<tr>
8889
<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>
9092
</tr>
9193
<tr>
9294
<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>
9497
</tr>
9598
<tr>
9699
<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>
98102
</tr>
99103
<tr>
100104
<td class=command><code>gb, list open issues with label foo</code>
@@ -113,7 +117,8 @@ <h2>Command quick reference</h2>
113117
<td class=command><code>gb, off<br>
114118
gb, on</code></td>
115119
<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 &amp; names; or turn it back
121+
on</a></td>
117122
</tr>
118123
<tr>
119124
<td class=command><code>gb, names off<br>
@@ -124,23 +129,24 @@ <h2>Command quick reference</h2>
124129
<tr>
125130
<td class=command><code>gb, issues off<br>
126131
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 &amp; discussions; or turn it back
134+
on</a></td>
129135
</tr>
130136
<tr>
131137
<td class=command><code>gb, delay 20</code></td>
132138
<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>
134140
</tr>
135141
<tr>
136142
<td class=command><code>gb, ignore RRSAgent, Zakim</code></td>
137-
<td><a href="#ignore">Nicks that cannot open or close issues
138-
&amp; actions</a></td>
143+
<td><a href="#ignore">Nicks that cannot open or close issues,
144+
actions, pull requests &amp; discussions</a></td>
139145
</tr>
140146
<tr>
141147
<td class=command><code>gb, don't ignore Zakim</code></td>
142-
<td><a href="#ignore">Let Zakim open/close issues &amp; actions
143-
again</a></td>
148+
<td><a href="#ignore">Let Zakim open/close issues, actions,
149+
pull requests &amp; discussions again</a></td>
144150
</tr>
145151
<tr>
146152
<td class=command><code>gb, Eve = eve78<br>
@@ -172,7 +178,8 @@ <h2 id=info>IRC command to link to an issue</h2>
172178

173179
<p>When somebody types something that looks like a repository name
174180
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>
176183

177184
<pre class=command>&lt;joe&gt; Let's talk about foo/bar#13.
178185
&lt;gb&gt; https://github.com/foo/bar/issues/13 -&gt; #13</pre>
@@ -190,8 +197,9 @@ <h2 id=info>IRC command to link to an issue</h2>
190197

191198
<p>Gb fails to look up an issue if it does not have access to
192199
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>
195203

196204
<p id=abbreviate>If you have told gb what repositories you are
197205
discussing
@@ -230,8 +238,9 @@ <h2 id=info>IRC command to link to an issue</h2>
230238

231239
<h2 id=url>Look up an issue by its URL</h2>
232240

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.:
235244

236245
<pre class=command>&lt;joe&gt; topic: https://github.com/w3c/scribe2/issues/15
237246
&lt;gb&gt; https://github.com/w3c/scribe2/issues/15 -&gt; 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>
274283

275284
<h2 id=repo>Specifying the GitHub repository</h2>
276285

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
278288
abbreviated syntax, you need to say what repository is being
279289
discussed on this channel:</p>
280290

@@ -385,9 +395,10 @@ <h2 id=create-action>Creating an action</h2>
385395
<p>Many different ways of describing a date are supported, including
386396
things like ‘in 2 weeks’, ‘tomorrow’ and ‘next Tuesday’.</p>
387397

388-
<h2 id=close>Closing an issue or action</h2>
398+
<h2 id=close>Closing an issue</h2>
389399

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
391402
with <code>close</code>, followed by an issue number or a URL,
392403
e.g.:</p>
393404

@@ -401,9 +412,10 @@ <h2 id=close>Closing an issue or action</h2>
401412
abbreviation, see <a href="#info" >‘IRC command to link to an
402413
issue: #’</a>.
403414

404-
<h2 id=reopen>Reopening an issue or action</h2>
415+
<h2 id=reopen>Reopening an issue</h2>
405416

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
407419
with <code>reopen</code>, followed by an issue number or a URL,
408420
e.g.:</p>
409421

@@ -451,7 +463,8 @@ <h2 id=action-format>Creating &amp; editing actions without Gb</h2>
451463

452464
<h2 id=comment>Adding a comment to an issue</h2>
453465

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
455468
commands <code>note</code> and <code>comment</code>, like
456469
this:</p>
457470

@@ -549,13 +562,12 @@ <h2 id=maxlines>Setting the number of full issues to display</h2>
549562
the number of lines per second, listing 10 issues already takes
550563
about 23 seconds.</p>
551564

552-
<h2 id=ignore>IRC nicks that should not open or close issues &amp;
553-
actions</h2>
565+
<h2 id=ignore>IRC nicks that should not open or close issues</h2>
554566

555567
<p>Certain IRC bots may print text that looks like an action or an
556568
issue, but isn't really. E.g., RRSAgent repeats all actions at the
557569
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
559571
list:
560572

561573
<pre class=command>&lt;joe&gt; gb, ignore RRSAgent</pre>
@@ -612,7 +624,8 @@ <h2 id=invite>Inviting and dismissing the bot</h2>
612624

613625
<h2 id=suspend>Suspending the bot</h2>
614626

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
616629
without dismissing it from the channel; and turn it back on
617630
again:</p>
618631

@@ -629,7 +642,7 @@ <h2 id=suspend>Suspending the bot</h2>
629642
or <code>false</code>. And instead of <code>names</code> you can
630643
also use <code>persons</code> or <code>teams</code>.</p>
631644

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
633646
actions, the command is:</p>
634647

635648
<pre class=command>&lt;joe&gt; gb, set issues to off

0 commit comments

Comments
 (0)