mirror of
https://github.com/pacnpal/Claude-code-review.git
synced 2025-12-19 20:01:05 -05:00
44d9ee380f8cc38850619f299dda266327a4b7b6
- Update Claude model from 3.5 to 4.5 (reflects actual implementation) - Add badges and visual improvements - Add "Why Use This Action?" section explaining benefits - Enhance Features section with detailed descriptions and icons - Add Table of Contents for better navigation - Improve Setup section with detailed prerequisites and configuration steps - Expand Development section with project structure and testing guidelines - Enhance Support section with helpful resources and links - Add Acknowledgments section crediting tools and libraries used - Fix references to dist/index.js in development documentation - Improve overall formatting and organization
Claude Code Review Action
A GitHub Action that performs automated code reviews using Claude Sonnet 4.5, Anthropic's latest AI model for code analysis.
Why Use Claude Code Review?
- Instant Feedback: Get AI-powered code reviews immediately on every pull request
- Consistent Quality: Apply consistent review standards across your entire codebase
- Save Time: Catch common issues before human review, allowing reviewers to focus on architecture and logic
- Learn & Improve: Get educational feedback that helps developers improve their coding skills
- 24/7 Availability: Reviews happen automatically, even outside business hours
Table of Contents
- Why Use Claude Code Review?
- Features
- Usage
- Setup
- Inputs
- Outputs
- Review Format
- Development
- Contributing
- License
- Support
Features
- 🤖 AI-Powered Reviews: Leverages Claude Sonnet 4.5 for intelligent code analysis
- 🔍 Comprehensive Analysis: Examines code changes in pull requests thoroughly
- 💡 Detailed Feedback: Provides actionable feedback on code quality and structure
- 🐛 Bug Detection: Identifies potential issues and suggests improvements
- 🔒 Security Scanning: Checks for security vulnerabilities and risks
- ⚡ Performance Insights: Highlights performance implications of code changes
- 📋 Best Practices: Ensures adherence to coding standards and best practices
- 🎯 Severity Ratings: Categorizes issues by severity (Critical/High/Medium/Low)
Usage
Add this to your GitHub workflow file (e.g. .github/workflows/review.yml):
name: Claude Code Review
permissions:
contents: read
pull-requests: write
on:
# Run on new/updated PRs
pull_request:
types: [opened, reopened, synchronize]
# Allow manual triggers for existing PRs
workflow_dispatch:
inputs:
pr_number:
description: 'Pull Request Number'
required: true
type: string
jobs:
code-review:
runs-on: ubuntu-latest
environment: development_environment
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Run Claude Review
uses: pacnpal/claude-code-review@main
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
anthropic-key: ${{ secrets.ANTHROPIC_API_KEY }}
pr-number: ${{ github.event.pull_request.number || inputs.pr_number }}
Manual Trigger
For existing pull requests, you can manually trigger the review:
- Click on "Claude Code Review" Action under the Actions tab
- Click "Run Workflow"
- Fill in the branch and pull request number
- Click "Run Workflow"
Setup
Prerequisites
- A GitHub repository
- An Anthropic API key (Get one here)
- GitHub Actions enabled in your repository
Configuration Steps
-
Add Anthropic API Key:
- Go to your repository Settings → Secrets and variables → Actions
- Click "New repository secret"
- Name:
ANTHROPIC_API_KEY - Value: Your Anthropic API key
- Click "Add secret"
-
GitHub Token:
- The
GITHUB_TOKENis automatically provided by GitHub Actions - No additional configuration needed
- The
-
Set Permissions (if needed):
- Ensure your workflow has proper permissions (see Usage example above)
- Required permissions:
contents: readandpull-requests: write
Inputs
| Input | Description | Required | Default |
|---|---|---|---|
github-token |
GitHub token for API access | Yes | N/A |
anthropic-key |
Anthropic API key for Claude | Yes | N/A |
pr-number |
Pull request number to review | Yes | N/A |
Outputs
| Output | Description |
|---|---|
diff_size |
Size of the relevant code changes |
review |
Generated code review content |
Review Format
The action provides detailed code reviews covering:
- Potential conflicts with existing codebase
- Code correctness and potential bugs
- Security vulnerabilities and risks
- Performance implications
- Maintainability and readability issues
- Adherence to best practices
- Suggestions for improvements
Each issue found includes:
- Clear problem explanation
- Severity rating (Critical/High/Medium/Low)
- Specific recommendations
- Code examples where helpful
Example Review
# Claude Code Review
1. **Potential conflicts with existing codebase**:
- No apparent conflicts identified
2. **Code correctness and potential bugs**:
- **Medium Severity**: Potential null pointer in user handling
- Recommendation: Add null check before accessing user object
3. **Security vulnerabilities and risks**:
- **High Severity**: SQL injection vulnerability in query construction
- Recommendation: Use parameterized queries
Development
Local Development Setup
-
Clone the repository:
git clone https://github.com/pacnpal/claude-code-review.git cd claude-code-review -
Install dependencies:
npm install -
Make your changes:
- Edit
action.jsfor core functionality - The built output goes to
dist/index.js
- Edit
-
Build the action:
npm run buildThis compiles
action.jsintodist/index.jsusing @vercel/ncc -
Run tests:
npm test
Project Structure
claude-code-review/
├── action.js # Main action logic
├── action.yml # Action metadata
├── dist/ # Built output (committed)
│ └── index.js # Compiled action
├── package.json # Dependencies
└── README.md # Documentation
Testing Changes
- Test your changes in a fork before submitting a PR
- Use the
workflow_dispatchtrigger for manual testing - Ensure
npm run buildcompletes without errors - Verify all tests pass with
npm test
Contributing
Contributions are welcome! Please:
- Fork the repository
- Create a feature branch
- Make your changes
- Run tests
- Submit a pull request
License
MIT License - see the LICENSE file for details
Support
Getting Help
- 🐛 Bug Reports: Open an issue with details and reproduction steps
- 💡 Feature Requests: Create an issue describing your use case
- 🤝 Contributions: Submit a PR following our contribution guidelines
- 📧 Questions: Open a discussion or contact the maintainers
Resources
Acknowledgments
Built with:
- Anthropic Claude API - AI-powered code analysis
- GitHub Actions - CI/CD automation platform
- @actions/core - GitHub Actions toolkit
- @vercel/ncc - Node.js bundler
Made with ❤️ by PacNPal | Report Bug | Request Feature
Languages
JavaScript
100%