mirror of
https://github.com/freeedcom/ai-codereviewer.git
synced 2025-04-20 17:46:47 +00:00
84 lines
3.6 KiB
Markdown
84 lines
3.6 KiB
Markdown
# AI Code Reviewer
|
|
|
|
AI Code Reviewer is a GitHub Action that leverages OpenAI's GPT-4 API to provide intelligent feedback and suggestions on
|
|
your pull requests. This powerful tool helps improve code quality and saves developers time by automating the code
|
|
review process.
|
|
|
|
## Features
|
|
|
|
- Reviews pull requests using OpenAI's GPT-4 API.
|
|
- Provides intelligent comments and suggestions for improving your code.
|
|
- Filters out files that match specified exclude patterns.
|
|
- Supports custom review rules to tailor the AI's feedback to your project's needs.
|
|
- Easy to set up and integrate into your GitHub workflow.
|
|
|
|
## Setup
|
|
|
|
1. To use this GitHub Action, you need an OpenAI API key. If you don't have one, sign up for an API key
|
|
at [OpenAI](https://beta.openai.com/signup).
|
|
|
|
2. Add the OpenAI API key as a GitHub Secret in your repository with the name `OPENAI_API_KEY`. You can find more
|
|
information about GitHub Secrets [here](https://docs.github.com/en/actions/reference/encrypted-secrets).
|
|
|
|
3. Create a `.github/workflows/main.yml` file in your repository and add the following content:
|
|
|
|
```yaml
|
|
name: AI Code Reviewer
|
|
|
|
on:
|
|
pull_request:
|
|
types:
|
|
- opened
|
|
- synchronize
|
|
permissions: write-all
|
|
jobs:
|
|
review:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout Repo
|
|
uses: actions/checkout@v3
|
|
|
|
- name: AI Code Reviewer
|
|
uses: your-username/ai-code-reviewer@main
|
|
with:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret)
|
|
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
|
|
OPENAI_API_MODEL: "gpt-4" # Optional: defaults to "gpt-4"
|
|
exclude: "**/*.json, **/*.md" # Optional: exclude patterns separated by commas
|
|
custom_rules: "Check for proper error handling, Ensure functions have proper docstrings, Verify variable names follow team conventions" # Optional: custom review rules separated by commas
|
|
```
|
|
|
|
4. Replace `your-username` with your GitHub username or organization name where the AI Code Reviewer repository is
|
|
located.
|
|
|
|
5. Customize the `exclude` input if you want to ignore certain file patterns from being reviewed.
|
|
|
|
6. Commit the changes to your repository, and AI Code Reviewer will start working on your future pull requests.
|
|
|
|
## How It Works
|
|
|
|
The AI Code Reviewer GitHub Action retrieves the pull request diff, filters out excluded files, and sends code chunks to
|
|
the OpenAI API. It then generates review comments based on the AI's response and adds them to the pull request.
|
|
|
|
### Custom Rules
|
|
|
|
You can provide custom review rules to tailor the AI's feedback to your project's specific needs. These rules are added to the prompt sent to the OpenAI API.
|
|
|
|
For example, if your team has specific coding conventions or you want to focus on particular aspects of code quality, you can specify them as custom rules:
|
|
|
|
```yaml
|
|
custom_rules: "Check for proper error handling, Make sure unit tests are included, Ensure all functions are properly documented"
|
|
```
|
|
|
|
Each rule should be a clear, concise instruction that guides the AI's review process.
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Please feel free to submit issues or pull requests to improve the AI Code Reviewer GitHub
|
|
Action.
|
|
|
|
Let the maintainer generate the final package (`yarn build` & `yarn package`).
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
|