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

Commit 78a09c8

Browse files
authored
update readme (#91)
1 parent 90f0a2c commit 78a09c8

File tree

3 files changed

+12
-11
lines changed

3 files changed

+12
-11
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# OpenAI GPT based PR reviewer and summarizer
1+
# OpenAI ChatGPT based PR reviewer and summarizer
22

33
![AI](./docs/images/ai.png)
44

55
## Overview
66

7-
This [OpenAI Chat](https://platform.openai.com/docs/guides/chat) based GitHub
7+
This [OpenAI ChatGPT](https://platform.openai.com/docs/guides/chat) based GitHub
88
Action provides a summary, release notes and review of pull requests. The
99
prompts have been tuned for a concise response. To prevent excessive
1010
notifications, this action can be configured to skip adding review comments when
@@ -68,11 +68,12 @@ See also: [./action.yml](./action.yml)
6868
6969
You can reply to a review comment made by this action and get a response based
7070
on the diff context. Additionally, you can invite the bot to a conversation by
71-
mentioning it in the beginning of the comment with `@openai`.
71+
tagging it in the comment (`@openai`).
7272

73-
Example:
73+
Examples:
7474

7575
> @openai Can you please review this block of code?
76+
> @openai Please generate a test plan for this file.
7677

7778
Note: A review comment is a comment made on a diff or a file in the pull
7879
request.

action.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
name: 'OpenAI-based PR Reviewer & Summarizer'
2-
description: 'OpenAI-based PR Reviewer and Summarizer'
1+
name: 'OpenAI ChatGPT based PR Reviewer & Summarizer'
2+
description: 'OpenAI ChatGPT based PR Reviewer and Summarizer'
33
branding:
44
icon: 'aperture'
55
color: 'orange'
@@ -63,15 +63,15 @@ inputs:
6363
openai_retries:
6464
required: false
6565
description:
66-
'How many times to retry openai API in case of timeouts or errors?'
66+
'How many times to retry OpenAI API in case of timeouts or errors?'
6767
default: '5'
6868
openai_timeout_ms:
6969
required: false
70-
description: 'Timeout for openai API call in millis'
71-
default: '60000'
70+
description: 'Timeout for OpenAI API call in millis'
71+
default: '120000'
7272
openai_concurrency_limit:
7373
required: false
74-
description: 'How many concurrent API calls to make to openai servers?'
74+
description: 'How many concurrent API calls to make to OpenAI servers?'
7575
default: '4'
7676
system_message:
7777
required: false

src/review-comment.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ export const handleReviewComment = async (
7979
if (
8080
comment_chain.includes(COMMENT_TAG) ||
8181
comment_chain.includes(COMMENT_REPLY_TAG) ||
82-
comment.body.startsWith(ASK_BOT)
82+
comment.body.includes(ASK_BOT)
8383
) {
8484
let file_content = ''
8585
try {

0 commit comments

Comments
 (0)