An AI-powered GitHub Action that automatically analyzes pull requests using Claude AI and provides intelligent code review insights, risk assessments, and complexity ratings.

🎥 Watch the setup tutorial on YouTube

PR Agent analyzes your pull requests and provides:

• Summary: Clear description of what the change does and its purpose
• Potential Risks: Identification of possible bugs, edge cases, or issues
• Complexity Rating: A 1-5 scale rating of the PR's complexity
• Actionable Insights: Specific recommendations for reviewers

Before setting up PR Agent in your project, you'll need:

1. Anthropic API Key: Sign up at Anthropic Console to get your API key
2. GitHub Repository: With permissions to add workflows and secrets

1. Create a workflow file in your repository:

   mkdir -p .github/workflows

2. Create .github/workflows/pr-agent.yml:

   name: PR Analyzer
   on:
     pull_request:
       types: [opened, synchronize, reopened]
   
   permissions:
     pull-requests: write
     issues: write
     contents: read
   
   jobs:
     analyze:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v4
   
         - name: Run PR Analyzer
           uses: techdebtgpt/[email protected]
           with:
             config-path: .pr-analyzer.yml
           env:
             ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   

Add your Anthropic API key to your repository secrets:

1. Go to your repository on GitHub
2. Navigate to Settings → Secrets and variables → Actions
3. Click New repository secret
4. Name: ANTHROPIC_API_KEY
5. Value: Your Anthropic API key
6. Click Add secret

Note: GITHUB_TOKEN is automatically provided by GitHub Actions, no manual setup required.

Once set up, PR Agent automatically runs on:

• New pull requests (opened)
• Updates to existing pull requests (synchronize)
• Reopened pull requests (reopened)

1. PR Opened/Updated: When a PR is created or updated, the workflow triggers
2. Fetch Changes: The action retrieves all file changes (diffs) from the PR
3. AI Analysis: Sends the diff to Claude AI for analysis
4. Post Comment: Posts a comprehensive analysis comment on the PR

When PR Agent analyzes your pull request, it posts a comment like:

## 🤖 AI Analysis

### Summary
This PR refactors the authentication middleware to use JWT tokens instead of session-based auth. It introduces a new TokenService class and updates all route handlers to use the new authentication method.

### Potential Risks
- The migration from session to JWT may break existing authenticated users
- No token expiration handling is implemented in the TokenService
- Error handling in the authenticate middleware could expose sensitive information

### Complexity: 4/5
This is a significant architectural change affecting multiple parts of the application. Careful testing of all authenticated endpoints is recommended.

### Recommendations
- Add integration tests for the new authentication flow
- Implement token refresh mechanism
- Review error messages to ensure no sensitive data leaks

If you want to contribute or modify PR Agent:

git clone https://github.com/YOUR_USERNAME/pr-agent.git
cd pr-agent

npm install

npm run build:action

Creates the dist/ directory that is neccessary for the build to run

To test the action locally, you can:

1. Set environment variables:

   ANTHROPIC_API_KEY="your-api-key"

2. Create a test PR in a repository you own

3. Run the action (requires GitHub Actions context)

pr-agent/
├── src/
│   ├── action.ts      # Main GitHub Action entry point
│   ├── analyzer.ts    # Claude AI integration
│   ├── types.ts       # TypeScript type definitions
│   └── index.ts       # Additional exports
├── dist/              # Compiled JavaScript (generated)
├── action.yml         # GitHub Action configuration
├── .pr-analyzer.yml   # PR Analyzer file configuration
├── package.json       # Node.js dependencies
├── tsconfig.json      # TypeScript configuration
└── README.md          # This file

1. Trigger: GitHub Action triggers on PR events
2. Fetch Diffs: Uses GitHub API to retrieve all changed files and their diffs
3. Prepare Prompt: Constructs a detailed prompt with the PR title and diffs
4. AI Analysis: Sends to Claude 3.5 Sonnet for analysis
5. Parse Response: Extracts structured insights from Claude's response
6. Post Comment: Creates a formatted comment on the PR using GitHub API

• Verify workflow file is in .github/workflows/ directory
• Check workflow triggers match PR events
• Ensure repository permissions allow Actions to run

• Verify ANTHROPIC_API_KEY secret is set correctly
• Check workflow permissions include pull-requests: write
• Review Action logs for error messages

• Check if your Anthropic API key is valid and has available credits
• Verify the API key has not expired
• Review Action logs for detailed error messages

• For very large PRs, the diff might exceed token limits
• Consider breaking large PRs into smaller, focused changes
• Future versions will include diff size limits and chunking

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

For issues, questions, or feature requests:

• Open an issue on GitHub Issues
• Check existing issues for solutions
• Review Action logs for debugging

Planned features:

• Configuration file support (.pr-analyzer.yml)
• Customizable analysis prompts
• Support for multiple AI providers
• Diff size limits and smart chunking
• File-level analysis comments
• Security vulnerability detection
• Performance impact analysis
• Custom analysis rules