Skip to content

v2 - NPM Package Support

Latest
Marketplace
Latest
Marketplace
Compare
Choose a tag to compare
@diekotto diekotto released this 05 Jan 17:05
· 5 commits to main since this release
v2
7a80156

Release Notes - AI Pull Review v2

Major Features 🚀

NPM Package Support

  • Now available as an NPM package @diekotto/ai-pull-review-cli
  • Global installation support via npm install
  • Direct execution support via npx
  • Requires Node.js >= 22.0.0 and NPM >= 10.0.0

CLI Capabilities

  • New command-line interface for running analysis outside GitHub Actions
  • Flexible configuration options via CLI arguments
  • Support for local output and GitHub PR comments
  • Environment variable support for tokens and keys

Cost Management

  • Added token usage tracking
  • Cost estimation for API calls
  • Detailed cost breakdown per analysis
  • Cost reporting in PR comments

Technical Improvements 🛠

Code Structure

  • Modular architecture with separate concerns
  • Dedicated analyzers and utilities
  • Improved file filtering system
  • Batch processing for API calls

API Integration

  • Updated Anthropic API client implementation
  • Support for latest Claude 3 models
  • Batch request handling for better performance
  • Improved error handling and retries

File Processing

  • Smart file filtering based on patterns
  • Size and complexity limits enforcement
  • Skip handling for problematic files
  • Support for various file types and languages

Configuration Enhancements ⚙️

Analysis Levels

  • Basic: Quick review for immediate issues
  • Standard: Comprehensive code analysis
  • Deep: In-depth review including architecture

Model Selection

  • Support for multiple Claude 3 models
  • Model-specific pricing awareness
  • Performance vs cost optimization options

Documentation Updates 📚

  • Comprehensive README overhaul
  • Detailed CLI usage instructions
  • Advanced configuration examples
  • Clear prerequisites and requirements

Bug Fixes 🐛

  • Fixed token calculation for large files
  • Improved error handling for API failures
  • Better handling of file encoding issues
  • Fixed pattern matching in file filters

Security Improvements 🔒

  • Improved token handling
  • Better error message sanitization
  • Enhanced file content validation

Requirements 📋

  • Node.js >= 22.0.0
  • NPM >= 10.0.0
  • GitHub token with appropriate permissions
  • Anthropic API key

Installation

# Global installation
npm install -g @diekotto/ai-pull-review-cli

# Or run directly with npx
npx @diekotto/ai-pull-review-cli

Breaking Changes ⚠️

  • Removed support for older Node.js versions
  • Changed default model to claude-3-5-haiku-20241022
  • Updated minimum required permissions for GitHub tokens

Coming Soon 🔜

  • Support for more version control systems
  • Additional analysis types
  • Custom rule configurations
  • Integration with more CI/CD platforms

Contributors 👥

Special thanks to all contributors who helped make this release possible.

Support

For issues and feature requests, please use our GitHub issue tracker.

Assets 2
Loading