Skip to content

lfsevergnini/ai-codereviewer

 
 

Repository files navigation

AI Code Reviewer

AI Code Reviewer is a GitHub Action that leverages multiple AI providers (OpenAI, Anthropic, Google) 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

  • Supports multiple AI providers:
    • OpenAI (ChatGPT)
    • Anthropic (Claude)
    • Google (Gemini)
  • Provides intelligent comments and suggestions for improving your code
  • Reviews only new changes in PR updates
  • Filters out files that match specified exclude patterns
  • Easy to set up and integrate into your GitHub workflow

Setup

  1. Choose your preferred AI provider and get an API key:

  2. Add the API key as a GitHub Secret in your repository:

    • OPENAI_API_KEY for OpenAI
    • ANTHROPIC_API_KEY for Claude
    • GOOGLE_AI_KEY for Google Gemini
  3. Create .github/workflows/code-review.yml:

name: AI Code Review on: pull_request: types: [opened, synchronize] permissions: write-all jobs: review: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: AI Code Review uses: your-username/ai-code-reviewer@main with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Choose your AI provider and key AI_PROVIDER: "openai" # or "anthropic" or "google" AI_API_KEY: ${{ secrets.OPENAI_API_KEY }} AI_MODEL: "gpt-4o-mini" AI_TEMPERATURE: 0.3 # 0 to 1 - higher values = more creativity and variance # Optional configurations APPROVE_REVIEWS: true MAX_COMMENTS: 10 # 0 to disable PROJECT_CONTEXT: "This is a Node.js TypeScript project" CONTEXT_FILES: "package.json,README.md" EXCLUDE_PATTERNS: "**/*.lock,**/*.json,**/*.md"

Configuration

Input Description Default
AI_PROVIDER AI provider to use (openai, anthropic, google) openai
AI_API_KEY API key for chosen provider Required
AI_MODEL Model to use (see supported models below) Provider's default
AI_TEMPERATURE Temperature for AI model 0
APPROVE_REVIEWS Whether to approve PRs automatically true
MAX_COMMENTS Maximum number of review comments 0
PROJECT_CONTEXT Project context for better reviews ""
CONTEXT_FILES Files to include in review (comma-separated) "package.json,README.md"
EXCLUDE_PATTERNS Files to exclude (glob patterns, comma-separated) "**/*.lock,**/*.json,**/*.md"

Supported Models

All models supported by the provider should be supported.

Development

# Install dependencies yarn install # Build TypeScript files yarn build # Run unit tests yarn test # Package for distribution yarn package # Generate test PR payload (for e2e testing) yarn generate-pr-payload <owner> <repo> <pr_number> # Run end-to-end tests yarn test:e2e <owner> <repo> <pr_number>

Testing Locally

To test the action locally:

  1. Create a .env file with your credentials:
GITHUB_TOKEN=your_github_token AI_PROVIDER=openai # or anthropic, google AI_API_KEY=your_api_key AI_MODEL=your_preferred_model
  1. Generate a test PR payload:
yarn generate-pr-payload <owner> <repo> 123
  1. Run the e2e test:
yarn test:e2e <owner> <repo> 123

Note: Make sure you have write access to the repository you're testing with.

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

License

MIT License - see LICENSE for details.

About

Advanced AI-powered code reviews with multiple model support

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 88.3%
  • JavaScript 11.7%