Skip to content
This repository has been archived by the owner on Mar 6, 2024. It is now read-only.

Commit

Permalink
ask bot to do security reviews (#92)
Browse files Browse the repository at this point in the history
  • Loading branch information
harjotgill authored Mar 27, 2023
1 parent 78a09c8 commit 0ee729d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 23 deletions.
22 changes: 3 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,6 @@ jobs:
review_comment_lgtm: false
```
### Configuration
See also: [./action.yml](./action.yml)
### Conversation with OpenAI
You can reply to a review comment made by this action and get a response based
Expand All @@ -73,6 +69,7 @@ tagging it in the comment (`@openai`).
Examples:

> @openai Can you please review this block of code?

> @openai Please generate a test plan for this file.

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

#### Inputs

- `debug`: Enable debug mode, will show messages and responses between OpenAI
server in CI logs.
- `max_files_to_summarize`: Maximum number of files to be summarized. Less than
or equal to 0 means no limit.
- `max_files_to_review`: Maximum number of files to be reviewed. Less than or
equal to 0
- `review_comment_lgtm`: Leave comments even the patch is LGTM
- `path_filters`: Rules to filter files to be reviewed.
- `temperature`: Temperature of the GPT-3 model.
- `system_message`: The message to be sent to OpenAI to start a conversation.

### Prompt templates:
### Prompts & Configuration

See: [./action.yml](./action.yml)
See: [action.yml](./action.yml)

Any suggestions or pull requests for improving the prompts are highly
appreciated.
Expand Down
8 changes: 4 additions & 4 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@ inputs:
Your role today is to conduct code and documentation reviews, and
generate code and documentation if asked to do so. You will point
out potential issues such as logic errors, syntax errors, out of
bound errors, data races, livelocks, starvation, suspension, order
violation, atomicity violation, consistency, complexity, error
handling, typos, grammar, and more.
out potential issues such as security (e.g. XSS), logic errors,
syntax errors, out of bound errors, data races, livelocks, starvation,
suspension, order violation, atomicity violation, consistency,
complexity, error handling, typos, grammar, and more.
summarize_beginning:
required: false
description: 'The prompt for the whole pull request'
Expand Down

0 comments on commit 0ee729d

Please sign in to comment.