ChatGPT-Reviewer
ChatGPT-Reviewer copied to clipboard
feiskyer
Automated pull requests reviewing and issues triaging with ChatGPT.
ChatGPT-Reviewer
Automated pull requests reviewing and issues triaging with ChatGPT.
How to use
Create an OpenAI API key here, and then set the key as an action secret in your repository named OPENAI_API_KEY.
Finally, create a file named .github/workflows/chatgpt-review.yml with the following contents:
name: ChatGPT Review
on: [pull_request]
jobs:
chatgpt-review:
name: ChatGPT Review
runs-on: ubuntu-latest
steps:
- uses: feiskyer/ChatGPT-Reviewer@v0
name: ChatGPT Review
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
# OPENAI_API_BASE: ${{ secrets.OPENAI_API_BASE }}
# Optional configurations:
# with:
# model: "gpt-3.5-turbo"
# temperature: 0.2
# review_per_file: true
# comment_per_file: true
Configurations
| Parameter | Description | Required | Default |
|---|---|---|---|
| GITHUB_TOKEN | Github token used to send out review comments | true | "" |
| OPENAI_API_KEY | API key used to invoke OpenAI | true | "" |
| OPENAI_API_BASE | API based used to access Azure OpenAI | false | "" |
| blocking | Blocking the pull requests on OpenAI failures | false | False |
| model | OpenAI model name | false | gpt-3.5-turbo |
| temperature | Temperature for the model | false | 0.2 |
| frequency_penalty | Frequency penalty for the model | false | 0 |
| presence_penalty | Presence penalty for the model | false | 0 |
| review_per_file | Send out review requests per file | false | Large changes would be reviewed per file automatically |
| comment_per_file | Post review comments per file | false | True |
Samples
The ChatGPT reviewer PRs are also getting reviewed by ChatGPT, refer the pull requests for the sample review comments.
Special notes for public repository forks
In order to protect public repositories for malicious users, Github runs all pull request workflows raised from repository forks with a read-only token and no access to secrets.
pull_request_target event could be used in such cases, which would run the workflow in the context of the base of the pull request (rather than in the context of the merge commit, as the pull_request event does).
Refer Github docs here for more details of pull_request_target event.
feiskyer