Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 5599b53

Browse files
committed
Add the summary command. Clarify what ignore does.
1 parent c20141c commit 5599b53

File tree

1 file changed

+34
-21
lines changed

1 file changed

+34
-21
lines changed

docs/guides/commands.md

Lines changed: 34 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ request description, as specified by the next sections of this page.
1212

1313
For a complete CodeRabbit command reference, see [Code review command reference](/reference/review-commands).
1414

15-
## Control the flow of code reviews {#flow}
15+
## Control automatic code reviews {#flow}
1616

1717
By default, CodeRabbit automatically reviews every new pull request created in
1818
your repository. It updates its review with comments whenever the pull request has new commits
@@ -24,26 +24,7 @@ a specific pull request, such as pausing reviews, or resolving open comments.
2424
For more information about permanently configuring the behavior of CodeRabbit on
2525
your repository, see [Add a configuration file](/getting-started/configure-coderabbit).
2626

27-
### Have CodeRabbit ignore a pull request {#ignore}
28-
29-
If you want CodeRabbit to completely disregard a pull request, then add
30-
the following text, on a line by itself, to the pull request description:
31-
32-
```
33-
@coderabbitai ignore
34-
```
35-
36-
You can include this line while creating the pull request, or you can add it
37-
to the description after you create it.
38-
39-
So long as the `@coderabbitai ignore` line remains in the pull request description, CodeRabbit
40-
doesn't perform any processing at all on this pull request. This also causes
41-
CodeRabbit to ignore any attempts to issue to commands using comments that mention `@coderabbitai`.
42-
43-
To have CodeRabbit stop ignoring a pull request, edit the description to
44-
remove the `@coderabbitai ignore` line.
45-
46-
### Pause and resume code reviews {#pause-resume}
27+
### Pause and resume automatic code reviews {#pause-resume}
4728

4829
You can tell CodeRabbit to pause its automatic reviews of a pull request. If
4930
you do, then you can still manually request CodeRabbit to review changes using
@@ -63,6 +44,24 @@ pull request:
6344
@coderabbitai resume
6445
```
6546

47+
### Disable automatic code reviews {#ignore}
48+
49+
To disable automatic code reviews for a pull request, add the following line
50+
anywhere in the pull request description:
51+
52+
```
53+
@coderabbitai ignore
54+
```
55+
56+
As long as that text remains in the description, CodeRabbit will not
57+
automatically review any commits associated with that pull request.
58+
You can still [chat with CodeRabbit](/guides/agent_chat) and issue other commands in the pull
59+
request comments.
60+
61+
To enable automatic reviews on that pull request, delete "`@coderabbitai ignore`"
62+
from the pull request description. CodeRabbit commences automatic reviews starting with
63+
the next commit made to the branch under review.
64+
6665
## Manually request code reviews {#request}
6766

6867
You can ask CodeRabbit to perform a code review at any time. This can be useful
@@ -97,6 +96,20 @@ pull request:
9796
@coderabbitai resolve
9897
```
9998

99+
## Generate summary text {#summary}
100+
101+
To have CodeRabbit add or update a generated summary of the branch’s proposed changes
102+
to the pull request’s description, post the following comment:
103+
pull request:
104+
105+
```
106+
@coderabbitai summary
107+
```
108+
109+
CodeRabbit appends the summary text to the description under the heading
110+
"Summary by CodeRabbit". If CodeRabbit has previously added a summary under that
111+
heading, then it replaces it with the new summary.
112+
100113
## Get information about CodeRabbit {#info}
101114

102115
The commands in this section request CodeRabbit to display its own configuration

0 commit comments

Comments
 (0)