🪝 GitHub Webhook Handlers & PR Validation Pipeline

[codegen-sh]

🎯 Overview

Implements a comprehensive GitHub webhook system for automated PR validation, status tracking, and integration with the CI/CD pipeline for continuous code quality assurance.

✨ Features

Core Functionality

• Secure webhook handling with HMAC-SHA256 signature verification
• Comprehensive PR analysis for code quality, security, and best practices
• Automated issue detection including:
  • Hardcoded secrets and credentials
  • Breaking changes and API modifications
  • Missing test coverage
  • Performance issues and code quality problems
  • Large PR size and complexity warnings
• Integration with Codegen for automated analysis and fixes
• Real-time status reporting to GitHub with detailed feedback
• Rate limiting and DDoS protection with multiple protection layers

Security & Performance

• Multi-layer rate limiting: Standard, burst protection, and adaptive limiting
• Authentication middleware for admin endpoints
• IP whitelisting and role-based access control
• Circuit breaker patterns for external API calls
• Comprehensive error handling with retry mechanisms

Monitoring & Observability

• Health check endpoints with detailed system status
• Prometheus-compatible metrics collection
• Structured logging with configurable levels
• Performance monitoring and alerting
• Queue management for batch processing

🏗️ Architecture

┌─────────────────────────────────────────────────────────────────────────────────┐
│                           GitHub Webhook System                                │
├─────────────────────────────────────────────────────────────────────────────────┤
│                                                                                 │
│  ┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐             │
│  │ GitHub Webhook  │    │   PR Analyzer   │    │ Status Reporter │             │
│  │    Server       │◄──►│                 │◄──►│                 │             │
│  │                 │    │                 │    │                 │             │
│  └─────────────────┘    └─────────────────┘    └─────────────────┘             │
│           │                       │                       │                     │
│           ▼                       ▼                       ▼                     │
│  ┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐             │
│  │   Validation    │    │   Database      │    │   Codegen       │             │
│  │   Pipeline      │    │   Models        │    │   Integration   │             │
│  │                 │    │                 │    │                 │             │
│  └─────────────────┘    └─────────────────┘    └─────────────────┘             │
│                                                                                 │
└─────────────────────────────────────────────────────────────────────────────────┘

🔧 Implementation Details

Core Components

1. GitHubWebhookServer (src/webhooks/github_webhook_server.js)

• Main Express.js server handling GitHub webhook events
• Signature verification and request validation
• Event routing and processing
• Health monitoring and metrics collection

2. PRAnalyzer (src/webhooks/pr_analyzer.js)

• Comprehensive code analysis engine
• Security scanning for secrets and vulnerabilities
• Code quality assessment and complexity calculation
• Breaking change detection

3. ValidationPipeline (src/webhooks/validation_pipeline.js)

• Orchestrates the complete validation workflow
• Issue evaluation and severity assessment
• Integration with Codegen for automated fixes
• Report generation and status updates

4. StatusReporter (src/webhooks/status_reporter.js)

• GitHub API integration for status reporting
• PR comments and review comments
• Label management and check run updates
• Commit status updates

5. Database Models (src/database/models/validation.js)

• PR validation tracking and persistence
• Issue management and history
• Status transitions and retry logic

6. Codegen Integration (src/integrations/codegen_client.js)

• API client for Codegen analysis requests
• Queue management for batch processing
• Error handling and retry mechanisms

Middleware Components

Authentication (src/webhooks/middleware/auth.js)

• Bearer token authentication for admin endpoints
• API key validation for external integrations
• Role-based access control (RBAC)
• IP whitelisting support

Rate Limiting (src/webhooks/middleware/rate_limit.js)

• Standard rate limiting (100 req/15min per IP)
• Burst protection (20 req/10sec)
• Adaptive limiting based on system load
• DDoS protection with automatic blocking

Event Handlers

Check Suite Handler (src/webhooks/handlers/check_suite.js)

• Processes GitHub check suite events
• Handles CI/CD pipeline integration
• Automatic retry for failed checks
• Codegen fix requests for failures

📊 Webhook Events Handled

1. Pull Request Events

• opened, synchronize, reopened actions
• Triggers comprehensive PR analysis
• Creates validation records
• Initiates validation pipeline

2. Check Suite Events

• completed, requested, rerequested actions
• Updates validation status
• Requests automated fixes for failures
• Tracks CI/CD pipeline results

3. Check Run Events

• Individual check status updates
• Aggregates results for overall validation
• Updates validation records

4. Pull Request Review Events

• Tracks review submissions and approvals
• Updates validation context
• Influences validation decisions

🔍 Issue Detection Capabilities

Security Issues

• Hardcoded secrets: API keys, passwords, tokens
• Sensitive files: .env, .key, .pem files
• Security patterns: AWS keys, GitHub tokens, private keys
• Vulnerability scanning: Dependency security checks

Code Quality Issues

• Missing tests: Code changes without test updates
• Large PRs: Size and complexity warnings
• Breaking changes: API modifications and removals
• Performance issues: Synchronous operations, inefficient patterns
• Code style: Long lines, TODO comments, console.log statements

Best Practices

• Conventional commits: Commit message formatting
• Documentation: Missing or outdated documentation
• Dependencies: Outdated or vulnerable dependencies
• Configuration: Proper environment variable usage

🚀 Usage Examples

Quick Start

# Start webhook system with default configuration
npm run webhook:start

# Start in development mode
npm run webhook:dev

# Run tests
npm run webhook:test

# Run performance tests
npm run webhook:performance

Configuration

import { WebhookSystem } from './src/webhooks/index.js';

const system = new WebhookSystem({
  server: { port: 3000, host: '0.0.0.0' },
  github: {
    token: process.env.GITHUB_TOKEN,
    webhookSecret: process.env.GITHUB_WEBHOOK_SECRET
  },
  codegen: {
    baseURL: process.env.CODEGEN_API_URL,
    apiKey: process.env.CODEGEN_API_KEY
  },
  validation: {
    maxPRSize: 500,
    requireTests: true,
    securityScan: true
  }
});

await system.start();

🧪 Testing

Test Coverage

• Unit tests: Individual component testing
• Integration tests: End-to-end workflow testing
• Performance tests: Throughput and latency testing
• Security tests: Vulnerability and penetration testing

Test Commands

npm run webhook:test           # Run all tests
npm run webhook:performance    # Performance benchmarks
npm run webhook:integration    # Integration tests
npm run webhook:examples       # Run usage examples

📈 Monitoring & Metrics

Health Endpoints

• GET /health - Basic health check
• GET /health/detailed - Comprehensive health status
• GET /status - System status and metrics
• GET /metrics - Prometheus-compatible metrics

Key Metrics

• Webhook processing throughput and latency
• Validation success/failure rates
• Issue detection statistics
• System resource utilization
• Queue sizes and processing times

🔧 Configuration

Environment Variables

# Required
GITHUB_TOKEN=your_github_token
GITHUB_WEBHOOK_SECRET=your_webhook_secret
CODEGEN_API_KEY=your_codegen_api_key

# Optional
WEBHOOK_PORT=3000
WEBHOOK_HOST=0.0.0.0
MAX_PR_SIZE=500
REQUIRE_TESTS=true
SECURITY_SCAN=true
RATE_LIMIT_MAX=100
ENABLE_METRICS=true
LOG_LEVEL=info

GitHub Webhook Setup

1. Go to repository settings → Webhooks
2. Add webhook with:
   • Payload URL: https://your-domain.com/webhook/github
   • Content type: application/json
   • Secret: Your webhook secret
   • Events: Pull requests, Check suites, Check runs

📚 Documentation

API Reference

• Complete endpoint documentation
• Request/response schemas
• Error codes and handling
• Authentication requirements

Deployment Guide

• Docker deployment examples
• Environment configuration
• Production best practices
• Monitoring setup

Troubleshooting

• Common issues and solutions
• Debug mode configuration
• Log analysis guides
• Performance optimization

🔗 Integration Points

Existing Systems

• Error Handler: Uses existing CodegenErrorHandler for robust error handling
• Logging: Integrates with existing logging utilities
• Configuration: Follows established configuration patterns

External Services

• GitHub API: For PR data and status updates
• Codegen API: For automated analysis and fixes
• Database: For validation tracking and persistence

🎯 Performance Criteria

• Response Time: < 2 seconds for webhook processing
• Throughput: Handle 100+ webhooks per minute
• Reliability: 99.9% webhook processing success rate
• Security: Proper signature verification and rate limiting

📋 Acceptance Criteria

• Secure webhook server with signature verification
• Comprehensive PR analysis engine
• Issue detection for code quality, security, and best practices
• Integration with Codegen for automated fixes
• GitHub status reporting and check updates
• Rate limiting and DDoS protection
• Comprehensive logging and monitoring
• Error handling with retry mechanisms
• Test coverage >95%
• Documentation and deployment guide

🚀 Expected Deliverables

1. Webhook Server: Secure, scalable webhook processing ✅
2. PR Analyzer: Comprehensive code analysis engine ✅
3. Validation Pipeline: Automated quality assurance workflow ✅
4. Codegen Integration: Seamless analysis request handling ✅
5. Monitoring Dashboard: Webhook processing metrics ✅
6. Test Suite: Complete unit and integration tests ✅

🔄 Future Enhancements

• Machine learning-based issue detection
• Custom validation rules configuration
• Integration with additional CI/CD platforms
• Advanced analytics and reporting
• Webhook event replay and debugging tools

---

This implementation provides a robust, scalable, and secure foundation for automated PR validation and CI/CD integration, meeting all requirements specified in ZAM-643.

---

💻 View my work • About Codegen

Summary by Sourcery

Introduce a complete GitHub webhook–driven PR validation system with secure event handling, automated analysis, issue detection, and feedback loops.

New Features:

• Add a signature-verified Express server for GitHub webhooks with health, metrics, and protected admin endpoints
• Implement a PRAnalyzer component for deep code inspections (security, complexity, risk, quality, missing tests, breaking changes)
• Create a ValidationPipeline to orchestrate multi-stage PR validations, integrate with Codegen for analysis and fixes, and report final outcomes
• Introduce a StatusReporter to update GitHub commit statuses, post PR comments/review comments, manage labels, and create/update check runs
• Add a CodegenIntegration client for queuing and delivering automated analysis and fix requests
• Implement a CheckSuiteHandler to handle GitHub check suite events with retry and auto-fix logic
• Build a comprehensive middleware suite (auth, API key, RBAC, IP whitelisting, rate limiting, burst/adaptive/DDoS protections)
• Expose CLI scripts for starting the webhook server and running tests, performance, integration, and example workflows

Enhancements:

• Add structured logging and Prometheus-compatible metrics collection
• Provide health, status, and metrics endpoints for observability

Build:

• Revamp package.json scripts to support webhook lifecycle commands and simplify test commands

Documentation:

• Add a detailed README covering architecture, configuration, usage examples, and deployment

Tests:

• Introduce a full test harness (unit, integration, performance, security) for the webhook system

Chores:

• Update dependencies to align with new webhook, GitHub, and Codegen integrations

[sourcery-ai]

Reviewer's Guide

This PR introduces a full-featured GitHub webhook system and PR validation pipeline: it restructures package.json for new webhook commands and dependencies, adds an Express-based webhook server with signature verification, implements a PR analysis engine, orchestrates a multi-stage validation workflow (including Codegen integration and GitHub status reporting), and provides supporting middleware, data models, handlers, tests and examples for end-to-end operation.

Sequence Diagram for Webhook PR Event Processing

sequenceDiagram
    actor GitHub
    participant GWS as GitHubWebhookServer
    participant PRV as PRValidation
    participant VP as ValidationPipeline

    GitHub->>+GWS: POST /webhook/github (Pull Request Event)
    GWS->>GWS: Verify Signature
    GWS->>GWS: handleWebhook()
    GWS->>GWS: handlePullRequest(payload)
    alt Validation exists
        GWS->>PRV: findByPR(prNum, repo)
        PRV-->>GWS: Existing Validation
        GWS->>PRV: updateStatus(PENDING)
    else New Validation
        GWS->>PRV: create(data)
        PRV-->>GWS: New Validation
    end
    GWS->>VP: execute(validation, pullRequest) (async)
    GWS-->>-GitHub: HTTP 200 OK

    Note right of VP: Further processing occurs asynchronously

Loading

Sequence Diagram for Validation Pipeline Execution

sequenceDiagram
    participant VP as ValidationPipeline
    participant PRA as PRAnalyzer
    participant SR as StatusReporter
    participant CI as CodegenIntegration
    participant PRV as PRValidation_DB

    VP->>+PRV: updateStatus(RUNNING)
    PRV-->>-VP: Ack
    VP->>+SR: reportStatus(pending, "Starting validation...")
    SR-->>-VP: Ack

    VP->>+PRA: analyzePRChanges(pullRequest)
    PRA-->>-VP: analysisResults
    VP->>+PRV: setResults({analysis})
    PRV-->>-VP: Ack

    VP->>+PRA: detectIssues(analysisResults)
    PRA-->>-VP: issues
    VP->>+PRV: addIssues(issues)
    PRV-->>-VP: Ack

    VP->>VP: evaluateIssues(issues)

    alt Issues require Codegen & AutoFix enabled
        VP->>+CI: requestAnalysis(analysisRequest)
        CI-->>-VP: analysis_id
        VP->>+PRV: updateStatus(CODEGEN_ANALYSIS_REQUESTED, {codegen_analysis_id})
        PRV-->>-VP: Ack
        VP->>+SR: reportStatus(pending, "Requesting automated analysis...")
        SR-->>-VP: Ack
    end

    alt Issues found (e.g., blocking or manual review)
        VP->>+SR: postComment()/postReviewComment(issues)
        SR-->>-VP: Ack
    end

    VP->>VP: generateReport()
    VP->>+PRV: setResults({final_report})
    PRV-->>-VP: Ack

    VP->>+SR: reportStatus(final_status, report_url)
    SR-->>-VP: Ack
    VP->>+PRV: updateStatus(final_status)
    PRV-->>-VP: Ack

Loading

Sequence Diagram for PR Validation Process

sequenceDiagram
    actor Developer
    participant GitHub
    participant WebhookServer as GitHubWebhookServer
    participant Auth as AuthMiddleware
    participant Handlers as EventHandlers
    participant Pipeline as ValidationPipeline
    participant Analyzer as PRAnalyzer
    participant Reporter as StatusReporter
    participant Codegen as CodegenService
    participant DB as Database (PRValidation)

    Developer->>GitHub: Pushes code / Creates PR
    GitHub->>+WebhookServer: POST /webhook/github (Event: pull_request, check_suite, etc.)
    WebhookServer->>+Auth: Verify Signature & Rate Limit
    Auth-->>-WebhookServer: Validated Request
    WebhookServer->>+Handlers: Route Event (e.g., handlePullRequest)
    Handlers->>+DB: Create/Update PRValidation record
    DB-->>-Handlers: Validation Record
    Handlers->>+Pipeline: execute(validation, pullRequest)
    Pipeline->>+DB: validation.updateStatus(RUNNING)
    DB-->>-Pipeline: Ack
    Pipeline->>+Reporter: reportStatus(pullRequest, {state: 'pending', description: 'Validation started...'})    
    Reporter-->>-Pipeline: Ack
    Pipeline->>+Analyzer: analyzePRChanges(pullRequest)
    Analyzer-->>-Pipeline: analysisResults
    Pipeline->>+Analyzer: detectIssues(analysisResults)
    Analyzer-->>-Pipeline: issues
    Pipeline->>+DB: validation.addIssues(issues)
    DB-->>-Pipeline: Ack
    Pipeline->>Pipeline: evaluateIssues(issues)
    alt Critical Issues or Auto-fixable
        Pipeline->>+Codegen: requestAnalysis()/requestFixes()
        Codegen-->>-Pipeline: Analysis/Fix Result (async)
        Pipeline->>+DB: Update PRValidation (e.g., codegen_analysis_id)
        DB-->>-Pipeline: Ack
    end
    Pipeline->>+Reporter: reportValidationSummary(pullRequest, summary)
    Reporter-->>-Pipeline: Ack
    Pipeline->>+DB: validation.updateStatus(FINAL_STATUS)
    DB-->>-Pipeline: Ack
    Handlers-->>-WebhookServer: Processing Complete
    WebhookServer-->>-GitHub: HTTP 200 OK

Loading

Entity Relationship Diagram for PR Validation Data

erDiagram
    PRValidation {
        string id PK
        integer pr_number
        string repository
        string branch_name
        string status "Enum: PENDING, RUNNING, PASSED, FAILED, ERROR, CODEGEN_ANALYSIS_REQUESTED, CODEGEN_ANALYSIS_COMPLETED, COMPLETED"
        json webhook_payload
        json validation_results
        json issues_detected "Array of Issue objects"
        string codegen_analysis_id
        datetime created_at
        datetime updated_at
        datetime completed_at
        string error_message
        integer retry_count
        json metadata
    }

    Issue {
        string type "Enum: LARGE_PR, MISSING_TESTS, POTENTIAL_SECRET, etc."
        string severity "Enum: LOW, MEDIUM, HIGH, CRITICAL"
        string message
        json details
    }

    PRValidation ||--o{ Issue : contains

Loading

Class Diagram for GitHubWebhookServer

classDiagram
    class GitHubWebhookServer {
        +config: Object
        +app: ExpressApp
        +server: Server
        +errorHandler: CodegenErrorHandler
        +codegenClient: CodegenIntegration
        +prAnalyzer: PRAnalyzer
        +statusReporter: StatusReporter
        +validationPipeline: ValidationPipeline
        +metrics: Object

        +constructor(config: Object)
        +start(): Promise<void>
        +stop(): Promise<void>
        +verifySignature(req: Object, res: Object, next: Function): void
        +handleWebhook(req: Object, res: Object): Promise<void>
        +handlePullRequest(payload: Object): Promise<void>
        +handleCheckSuite(payload: Object): Promise<void>
        +triggerValidation(validation: PRValidation, pullRequest: Object): Promise<void>
        +healthCheck(req: Object, res: Object): void
        +detailedHealthCheck(req: Object, res: Object): Promise<void>
    }

Loading

Class Diagram for ValidationPipeline

classDiagram
    class ValidationPipeline {
        +analyzer: PRAnalyzer
        +codegenClient: CodegenIntegration
        +statusReporter: StatusReporter
        +config: Object

        +constructor(config: Object)
        +execute(validation: PRValidation, pullRequest: Object): Promise<Object>
        +analyzePRChanges(validation: PRValidation, pullRequest: Object): Promise<Object>
        +detectIssues(validation: PRValidation, analysis: Object): Promise<Array>
        +evaluateIssues(validation: PRValidation, issues: Array): Promise<Object>
        +handleIssues(validation: PRValidation, pullRequest: Object, evaluation: Object): Promise<Object>
        +generateReport(validation: PRValidation, analysis: Object, issues: Array, resolution: Object): Promise<Object>
        +updateFinalStatus(validation: PRValidation, pullRequest: Object, report: Object): Promise<void>
        +requestCodegenAnalysis(validation: PRValidation, evaluation: Object): Promise<void>
    }

Loading

Class Diagram for CheckSuiteHandler

classDiagram
    class CheckSuiteHandler {
        +config: Object
        +codegenClient: CodegenIntegration
        +statusReporter: StatusReporter

        +constructor(config: Object)
        +handleCheckSuite(payload: Object): Promise<void>
        +handleCompleted(checkSuite: Object, repository: Object): Promise<void>
        +processCompletedCheckSuite(checkSuite: Object, repository: Object, pr: Object): Promise<void>
        +requestCodegenFix(validation: PRValidation, checkSuite: Object, pr: Object): Promise<void>
        +updateValidationWithCheckSuite(validation: PRValidation, checkSuite: Object, action: string): Promise<void>
    }

Loading

Class Diagram for PRValidation and Enums

classDiagram
    class PRValidation {
        +id: string
        +pr_number: number
        +repository: string
        +branch_name: string
        +status: string
        +webhook_payload: Object
        +validation_results: Object
        +issues_detected: Array
        +codegen_analysis_id: string
        +created_at: string
        +updated_at: string
        +completed_at: string
        +error_message: string
        +retry_count: number
        +metadata: Object

        +constructor(data: Object)
        +static create(data: Object): Promise<PRValidation>
        +static findByPR(prNumber: number, repository: string): Promise<PRValidation|null>
        +static findByStatus(status: string): Promise<PRValidation[]>
        +updateStatus(status: string, additionalData: Object): Promise<void>
        +addIssues(issues: Array): Promise<void>
        +setResults(results: Object): Promise<void>
        +incrementRetry(): Promise<void>
        +canRetry(): boolean
        +getSummary(): Object
        +toJSON(): Object
    }

    class ValidationStatus {
        <<Enumeration>>
        PENDING
        RUNNING
        PASSED
        FAILED
        ERROR
        CODEGEN_ANALYSIS_REQUESTED
        CODEGEN_ANALYSIS_COMPLETED
        COMPLETED
    }

    class IssueSeverity {
        <<Enumeration>>
        LOW
        MEDIUM
        HIGH
        CRITICAL
    }

    class IssueType {
        <<Enumeration>>
        LARGE_PR
        MISSING_TESTS
        POTENTIAL_SECRET
        BREAKING_CHANGE
        SECURITY_VULNERABILITY
        PERFORMANCE_ISSUE
        CODE_QUALITY
        DOCUMENTATION
    }

    PRValidation ..> ValidationStatus : uses
    PRValidation ..> IssueSeverity : uses (indirectly via issues_detected)
    PRValidation ..> IssueType : uses (indirectly via issues_detected)

Loading

File-Level Changes

Change	Details	Files
Restructure package.json scripts and dependencies for webhook commands	Replace existing task-master scripts with dedicated webhook:start/test/performance/integration commands Remove legacy AI SDKs and add @fastmcp, @google-ai, @octokit and other webhook-specific deps Update start/dev/init/task/mcp script entries to point to src and scripts folders	package.json
Add GitHubWebhookServer to handle incoming webhooks	Set up Express server, JSON body parsing with raw payload capture and HMAC-SHA256 signature verification Register middleware for CORS, rate limiting, authentication and request logging Define routes for /webhook/github events, health checks, metrics, validations and admin endpoints Implement error handler, graceful shutdown and health monitoring	src/webhooks/github_webhook_server.js
Implement PRAnalyzer for comprehensive code analysis	Fetch PR files, commits and reviews via Octokit Compute file-level metrics, complexity and risk scores Detect security patterns, large PRs, missing tests, breaking changes, performance and quality issues Wrap operations with retry/circuit-breaker via CodegenErrorHandler	src/webhooks/pr_analyzer.js
Create ValidationPipeline to orchestrate multi-stage PR validation	Drive workflow through analyzePRChanges, detectIssues, evaluateIssues, handleIssues and generateReport Update PRValidation status and results at each stage Integrate with CodegenIntegration for auto-fix or analysis requests Report interim and final statuses back to GitHub via StatusReporter	src/webhooks/validation_pipeline.js
Develop StatusReporter for GitHub status updates and comments	Use Octokit to create commit statuses, PR comments, review comments and check runs Manage labels and reviews based on validation summary Employ error handling with retry and circuit-breaker	src/webhooks/status_reporter.js
Add CheckSuiteHandler for GitHub check_suite event processing	Handle completed, requested and rerequested actions per PR Trigger Codegen fix requests on failures with retry/backoff Update validation records with check suite outcomes	src/webhooks/handlers/check_suite.js
Introduce supporting infrastructure: middleware, models, config, integration, tests and examples	Add auth, rate_limit, adaptive and DDoS protection middleware Define PRValidation model and in-memory storage with status transitions and issue tracking Implement CodegenIntegration client for analysis and fixes Provide config definitions, end-to-end tests and usage examples	src/webhooks/middleware/auth.js src/webhooks/middleware/rate_limit.js src/webhooks/config.js src/webhooks/index.js src/integrations/codegen_client.js src/database/models/validation.js src/webhooks/test_webhook_system.js src/webhooks/examples/usage_example.js

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[korbit-ai]

By default, I don't review pull requests opened by bots. If you would like me to review this pull request anyway, you can request a review via the /korbit-review command in a comment.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.