Review Raccoon Documentation

Learn how to integrate Review Raccoon into your GitHub workflow to improve code quality.

Getting Started

Installation

You can install Review Raccoon directly from the GitHub Marketplace:

1
Navigate to the Review Raccoon GitHub Marketplace page.
2
Click the "Install it for free" button.
3
Select the repositories where you want to use Review Raccoon.

Setup Workflow File

Create a workflow file in your repository:

.github/workflows/review-raccoon.yml

name: Review Raccoon

on:
  pull_request:
    types:
      - opened
      - synchronize

permissions: write-all

jobs:
  code_review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3
      - name: Review Raccoon
        uses: Deepak-png981/AI-Code-Reviewer-Release@latest
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          OPENAI_API_MODEL: "gpt-4-1106-preview"
          exclude: "yarn.lock,dist/**"
          USER: "userId"

Configuration

Create a configuration file in your repository root:

.reviewraccoon.json

{
  "language": "auto",
  "ignorePatterns": [
    "node_modules/**",
    "dist/**",
    "build/**"
  ],
  "maxFiles": 20,
  "commentStyle": "inline",
  "focusAreas": [
    "security",
    "performance",
    "bestPractices",
    "codeStyle"
  ]
}

Configuration Options

language

Set to "auto" for automatic language detection or specify a language like "javascript", "python", etc.

ignorePatterns

Files or directories to ignore during analysis.

maxFiles

Maximum number of files to analyze per pull request.

commentStyle

Choose between "inline" (comments on specific lines) or "summary" (one comment with all feedback).

focusAreas

Specific aspects of code to focus on during review.

Advanced Usage

Custom Rules

Define custom rules in your configuration file:

{
  // ... other configuration
  "customRules": [
    {
      "pattern": "console\.log",
      "message": "Remove console.log statements before merging",
      "severity": "warning"
    }
  ]
}

Team Integration

For team environments, you can create a central configuration file that all repositories reference.

API Integration

Access Review Raccoon's API to integrate with your own tools and dashboards. See our API documentation for details.

Need more help?