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

update readme #91

Merged
merged 1 commit into from
Mar 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# OpenAI GPT based PR reviewer and summarizer
# OpenAI ChatGPT based PR reviewer and summarizer

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

## Overview

This [OpenAI Chat](https://platform.openai.com/docs/guides/chat) based GitHub
This [OpenAI ChatGPT](https://platform.openai.com/docs/guides/chat) based GitHub
Action provides a summary, release notes and review of pull requests. The
prompts have been tuned for a concise response. To prevent excessive
notifications, this action can be configured to skip adding review comments when
Expand Down Expand Up @@ -68,11 +68,12 @@ See also: [./action.yml](./action.yml)

You can reply to a review comment made by this action and get a response based
on the diff context. Additionally, you can invite the bot to a conversation by
mentioning it in the beginning of the comment with `@openai`.
tagging it in the comment (`@openai`).

Example:
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
request.
Expand Down
12 changes: 6 additions & 6 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: 'OpenAI-based PR Reviewer & Summarizer'
description: 'OpenAI-based PR Reviewer and Summarizer'
name: 'OpenAI ChatGPT based PR Reviewer & Summarizer'
description: 'OpenAI ChatGPT based PR Reviewer and Summarizer'
branding:
icon: 'aperture'
color: 'orange'
Expand Down Expand Up @@ -63,15 +63,15 @@ inputs:
openai_retries:
required: false
description:
'How many times to retry openai API in case of timeouts or errors?'
'How many times to retry OpenAI API in case of timeouts or errors?'
default: '5'
openai_timeout_ms:
required: false
description: 'Timeout for openai API call in millis'
default: '60000'
description: 'Timeout for OpenAI API call in millis'
default: '120000'
openai_concurrency_limit:
required: false
description: 'How many concurrent API calls to make to openai servers?'
description: 'How many concurrent API calls to make to OpenAI servers?'
default: '4'
system_message:
required: false
Expand Down
2 changes: 1 addition & 1 deletion src/review-comment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export const handleReviewComment = async (
if (
comment_chain.includes(COMMENT_TAG) ||
comment_chain.includes(COMMENT_REPLY_TAG) ||
comment.body.startsWith(ASK_BOT)
comment.body.includes(ASK_BOT)
) {
let file_content = ''
try {
Expand Down