Code Review Bot

Introduction

Code review bot is to automate code reviews by using OpenAI's language model.

It fetches code changes from GitHub pull requests on main branch, analyzes the changes using OpenAI's GPT model.

Posts feedback directly to the corresponding GitHub pull request.

Table of Contents

• Installation
• Usage
• Features
• Dependencies
• Configuration
• Documentation
• Examples

Installation

1. Clone the repository:

   git clone https://github.com/jeesup0103/CodeReviewBot.git
   cd CodeReviewBot
   

2. Install the required dependencies:

   pip install openai requests python-dotenv

3. Make GitHub repository secrets named OPENAI_API_KEY, REP_GH_TOKEN and BOT_GH_TOKEN

   OPENAI_API_KEY=your_openai_api_key
   REP_GH_TOKEN=your_repository_github_token
   BOT_GH_TOKEN=your_bot_github_token

Usage

To run the code review manually, create a .env file and add your GitHub token and OpenAI API key.

OPENAI_API_KEY=your_openai_api_key
REP_GH_TOKEN=your_repository_github_token
BOT_GH_TOKEN=your_bot_github_token

Then execute the following command:

python review_code.py <pr_url>

Replace <pr_url> with the URL of the pull request you want to review.

Example: https://api.github.com/repos/yourusername/yourrepo/pulls/1

Features

• Automated Code Review: Automatically fetches code changes from a GitHub pull request and generates a review using OpenAI's GPT model.
• Feedback Posting: Posts the generated feedback as a comment on the GitHub pull request.
• GitHub Actions Integration: Set up as a GitHub Action to automate the review process on each pull request to the main branch.

Configuration

GitHub Actions Workflow

The GitHub Actions workflow is defined in .github/workflows/main.yml. This workflow triggers on pull requests to the main branch and runs the code review:

name: Code Review Workflow

on:
  pull_request:
    branches:
      - main

jobs:
  code-review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v2

      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: '3.x'

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install openai requests python-dotenv

      - name: Run Code Review
        env:
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          python review_code.py ${{ github.event.pull_request.url }}

Examples

Run the code review on a specific pull request:

python review_code.py https://api.github.com/repos/yourusername/yourrepo/pulls/1