Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adshao/chatgpt-code-review-action
A GitHub Action that uses OpenAI ChatGPT to do code review
https://github.com/adshao/chatgpt-code-review-action
ai chatgpt code-review github github-actions openai
Last synced: 10 days ago
JSON representation
A GitHub Action that uses OpenAI ChatGPT to do code review
- Host: GitHub
- URL: https://github.com/adshao/chatgpt-code-review-action
- Owner: adshao
- Created: 2023-03-02T07:56:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-03-09T03:10:16.000Z (over 1 year ago)
- Last Synced: 2024-10-26T11:34:47.655Z (11 days ago)
- Topics: ai, chatgpt, code-review, github, github-actions, openai
- Language: JavaScript
- Homepage:
- Size: 473 KB
- Stars: 68
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Simplify code reviews, just say `chatgpt`!
# OpenAI ChatGPT Code Review
A GitHub Action that uses OpenAI ChatGPT to analyze code in pull request comments.
## Usage
To use this action in your workflow, add the following step:
```yaml
name: OpenAI ChatGPT Code Review
uses: adshao/[email protected]
with:
PROGRAMMING_LANGUAGE: 'JavaScript'
REVIEW_COMMENT_PREFIX: 'chatgpt:'
FULL_REVIEW_COMMENT: 'chatgpt'
OPENAI_TOKEN: ${{ secrets.OPENAI_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
```
## Inputs
This action accepts the following inputs:
- `PROGRAMMING_LANGUAGE` (optional): The programming language of the code in the GitHub repository. If not provided, the detected programming language will be used.
- `OPENAI_TOKEN` (required): The API token for the OpenAI ChatGPT API.
- `GITHUB_TOKEN` (required): The API token for the Github API.
- `FULL_REVIEW_COMMENT` (required): The comment to trigger code review for the pull request.
- `REVIEW_COMMENT_PREFIX` (required): The comment prefix to trigger code review with the comment.
- `GITHUB_BASE_URL` (optional): The base URL for the GitHub API.
- `MAX_CODE_LENGTH` (optional): The maximum code length for the pull request code to be sent to OpenAI. The default value is 6000.
- `PROMPT_TEMPLATE` (optional): The template for the FULL_REVIEW_COMMENT prompt. The default value is:
```
Please analyze the pull request's code and inform me whether it requires optimization, and provide an explanation for your decision:
${code}
```
- `ANSWER_TEMPLATE` (optional): The template for the answer sent to the GitHub comment. The default value is:
```
AI Code Review:
${answer}
```
## Outputs
This action does not produce any outputs.
## Example workflow
Here's an example workflow that uses this action to analyze code in pull request comments:
```yaml
name: Code Review
on:
issue_comment:
types: [created, edited]
jobs:
code-review:
runs-on: ubuntu-latest
if: github.event.comment.user.login == 'adshao' && startsWith(github.event.comment.body, 'chatgpt')
steps:
- name: OpenAI ChatGPT Code Review
uses: adshao/[email protected]
with:
PROGRAMMING_LANGUAGE: 'JavaScript'
OPENAI_TOKEN: ${{ secrets.OPENAI_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
FULL_REVIEW_COMMENT: 'chatgpt'
REVIEW_COMMENT_PREFIX: 'chatgpt:'
```
This workflow runs the `OpenAI ChatGPT Code Review` action when a pull request comment is created or edited. The action uses the `PROGRAMMING_LANGUAGE`, `FULL_REVIEW_COMMENT`, `REVIEW_COMMENT_PREFIX`, `OPENAI_TOKEN` and `GITHUB_TOKEN` input values to analyze the code in the pull request comment.
You can also trigger github action when a pull request opened.
## Github
### Code Review for PR
If a comment exactly matches `chatgpt`, a code review will be triggered for the pull request's diff.
Note that only the first 6000 characters of code will be used due to the token limit of the OpenAI API.
### Code Review for a specific file
If a comment starts with `chatgpt:`, you can use it to communicate with ChatGPT just like you would in the official interface.
To reference the diff code of the pull request in your comment, use ${code}:
```
chatgpt: Please explain the usage of the `getPrCode` function:
${code}
```
To reference the diff code of a specific file in the pull request, use ${file:filename}:
```
chatgpt: Can you check if there are any bugs in the following code?
${file:dist/index.js}
```
## Screenshots
## More Examples
`go-binance`: https://github.com/adshao/go-binance/pull/461#issuecomment-1452922686
## License
The code in this repository is licensed under the MIT license. See `LICENSE` for more information.