Skip to content

Commit 16e56cd

Browse files
authored
ask bot to do security reviews (coderabbitai#92)
1 parent 618630a commit 16e56cd

File tree

2 files changed

+7
-23
lines changed

2 files changed

+7
-23
lines changed

README.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,6 @@ jobs:
6060
review_comment_lgtm: false
6161
```
6262
63-
### Configuration
64-
65-
See also: [./action.yml](./action.yml)
66-
6763
### Conversation with OpenAI
6864
6965
You can reply to a review comment made by this action and get a response based
@@ -73,6 +69,7 @@ tagging it in the comment (`@openai`).
7369
Examples:
7470

7571
> @openai Can you please review this block of code?
72+
7673
> @openai Please generate a test plan for this file.
7774

7875
Note: A review comment is a comment made on a diff or a file in the pull
@@ -96,22 +93,9 @@ request.
9693
[here](https://platform.openai.com/account/api-keys). Please add this key to
9794
your GitHub Action secrets.
9895

99-
#### Inputs
100-
101-
- `debug`: Enable debug mode, will show messages and responses between OpenAI
102-
server in CI logs.
103-
- `max_files_to_summarize`: Maximum number of files to be summarized. Less than
104-
or equal to 0 means no limit.
105-
- `max_files_to_review`: Maximum number of files to be reviewed. Less than or
106-
equal to 0
107-
- `review_comment_lgtm`: Leave comments even the patch is LGTM
108-
- `path_filters`: Rules to filter files to be reviewed.
109-
- `temperature`: Temperature of the GPT-3 model.
110-
- `system_message`: The message to be sent to OpenAI to start a conversation.
111-
112-
### Prompt templates:
96+
### Prompts & Configuration
11397

114-
See: [./action.yml](./action.yml)
98+
See: [action.yml](./action.yml)
11599

116100
Any suggestions or pull requests for improving the prompts are highly
117101
appreciated.

action.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,10 @@ inputs:
8383
8484
Your role today is to conduct code and documentation reviews, and
8585
generate code and documentation if asked to do so. You will point
86-
out potential issues such as logic errors, syntax errors, out of
87-
bound errors, data races, livelocks, starvation, suspension, order
88-
violation, atomicity violation, consistency, complexity, error
89-
handling, typos, grammar, and more.
86+
out potential issues such as security (e.g. XSS), logic errors,
87+
syntax errors, out of bound errors, data races, livelocks, starvation,
88+
suspension, order violation, atomicity violation, consistency,
89+
complexity, error handling, typos, grammar, and more.
9090
summarize_beginning:
9191
required: false
9292
description: 'The prompt for the whole pull request'

0 commit comments

Comments
 (0)