Robin AI

Named after Batman's assistant, Robin AI is an open source Github action that automatically reviews pull requests using AI models from OpenAI (GPT) or Anthropic (Claude). It analyzes your code changes and provides:

• A quality score (0-100)
• Actionable improvement suggestions
• Sample code snippets for better implementation
• Fast, automated feedback (average runtime: 14s)

Table of Contents

• Prerequisites
• Installation
• Configuration
• Usage
• Example Output
• Performance
• Contributing
• License

Prerequisites

• A GitHub repository with pull request workflows
• An API key for your chosen AI provider:
  • OpenAI: Get an API key here
  • Claude (Anthropic): Get an API key here

Installation

1. In your Github repository, navigate to the "Actions" tab
2. Click "New workflow"
3. Choose "Set up a workflow yourself"
4. Create a new file (e.g., robin.yml) with one of these configurations:

Using OpenAI (Default)

name: Robin AI Reviewer

on:
  pull_request:
    branches: [main]
    types:
      - opened
      - reopened
      - ready_for_review

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3
      - name: Robin AI Reviewer
        uses: Integral-Healthcare/robin-ai-reviewer@v[INSERT_LATEST_RELEASE]
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          AI_PROVIDER: openai
          AI_API_KEY: ${{ secrets.OPEN_AI_API_KEY }}
          AI_MODEL: o4-mini
          files_to_ignore: |
            "README.md"
            "assets/*"
            "package-lock.json"

Using Claude (Anthropic)

name: Robin AI Reviewer

on:
  pull_request:
    branches: [main]
    types:
      - opened
      - reopened
      - ready_for_review

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3
      - name: Robin AI Reviewer
        uses: Integral-Healthcare/robin-ai-reviewer@v[INSERT_LATEST_RELEASE]
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          AI_PROVIDER: claude
          AI_API_KEY: ${{ secrets.CLAUDE_API_KEY }}
          AI_MODEL: claude-3-sonnet-20240229
          files_to_ignore: |
            "README.md"
            "assets/*"
            "package-lock.json"

Legacy Configuration (Still Supported)

name: Robin AI Reviewer

on:
  pull_request:
    branches: [main]
    types:
      - opened
      - reopened
      - ready_for_review

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3
      - name: Robin AI Reviewer
        uses: Integral-Healthcare/robin-ai-reviewer@v[INSERT_LATEST_RELEASE]
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPEN_AI_API_KEY: ${{ secrets.OPEN_AI_API_KEY }}
          gpt_model_name: o4-mini
          files_to_ignore: |
            "README.md"
            "assets/*"
            "package-lock.json"

5. Add your API key as a repository secret:
   • Go to repository Settings → Secrets and Variables → Actions
   • For OpenAI: Create a secret named OPEN_AI_API_KEY
   • For Claude: Create a secret named CLAUDE_API_KEY
   • Paste your API key as the value

Configuration

Parameters (Recommended)

Name	Required	Default	Description
GITHUB_TOKEN	Yes	Auto-supplied	GitHub token for API access
AI_PROVIDER	No	openai	AI provider to use (openai or claude)
AI_API_KEY	Yes	N/A	API key for the selected AI provider
AI_MODEL	No	Provider-specific	AI model to use (see supported models below)
github_api_url	No	https://api.github.com	GitHub API URL (for enterprise)
files_to_ignore	No	(empty)	Files to exclude from review

Legacy Parameters (Deprecated but still supported)

Name	Required	Default	Description
OPEN_AI_API_KEY	No	N/A	[DEPRECATED] Use AI_API_KEY instead
gpt_model_name	No	N/A	[DEPRECATED] Use AI_MODEL instead

Usage

When Robin AI runs, it will post a comment on the pull request with its score out of 100, suggested improvements, and sample code for improvement. You can use this information to improve the quality of your code and make your pull requests more likely to be accepted.

Example Output

When Robin AI reviews your pull request, you'll see a comment like this:

Score: 85/100

Improvements:

• Consider adding input validation for the user parameters
• The error handling could be more specific
• Variable naming could be more descriptive

# Before
def process(x):
    return x * 2

# After
def process_user_input(value: int) -> int:
    if not isinstance(value, int):
        raise ValueError("Input must be an integer")
    return value * 2

Performance

• Docker Image Size: 15.6MB
• Average Runtime: 14 seconds
• Memory Usage: Minimal (<100MB)

Demo

See Robin AI in action: View Demo

Contributing

We welcome contributions! Here's how you can help:

• Submit bug reports or feature requests through Issues
• Submit pull requests for bug fixes or new features
• Improve documentation
• Share feedback on Twitter

License

Robin AI is MIT licensed. See LICENSE for details.