|
| 1 | +# CodeRabbit Configuration for ReportPortal MCP Server |
| 2 | +# A Go-based Model Context Protocol server for ReportPortal integration |
| 3 | + |
| 4 | +# ============================================================================= |
| 5 | +# GLOBAL SETTINGS |
| 6 | +# ============================================================================= |
| 7 | + |
| 8 | +# Language for reviews |
| 9 | +language: "en-US" |
| 10 | + |
| 11 | +# Tone instructions for reviews - professional but constructive |
| 12 | +tone_instructions: "Focus on code quality, security, performance, and Go best practices. Be constructive and educational in feedback." |
| 13 | + |
| 14 | +# Enable early access features for improved functionality |
| 15 | +early_access: false |
| 16 | + |
| 17 | +# ============================================================================= |
| 18 | +# REVIEWS CONFIGURATION |
| 19 | +# ============================================================================= |
| 20 | + |
| 21 | +reviews: |
| 22 | + # Use assertive profile for better code quality feedback on this professional project |
| 23 | + profile: "assertive" |
| 24 | + |
| 25 | + # Enable high-level summaries for better PR understanding |
| 26 | + high_level_summary: true |
| 27 | + high_level_summary_in_walkthrough: true |
| 28 | + |
| 29 | + # Auto-generate PR titles when needed |
| 30 | + auto_title_placeholder: "@coderabbitai" |
| 31 | + auto_title_instructions: "Generate concise, descriptive titles following conventional commit format when applicable" |
| 32 | + |
| 33 | + # Review workflow settings |
| 34 | + review_status: true |
| 35 | + commit_status: true |
| 36 | + fail_commit_status: true |
| 37 | + |
| 38 | + # Enhanced walkthrough features |
| 39 | + collapse_walkthrough: false |
| 40 | + changed_files_summary: true |
| 41 | + sequence_diagrams: true |
| 42 | + estimate_code_review_effort: true |
| 43 | + assess_linked_issues: true |
| 44 | + related_issues: true |
| 45 | + related_prs: true |
| 46 | + |
| 47 | + # Label and reviewer suggestions |
| 48 | + suggested_labels: true |
| 49 | + auto_apply_labels: false |
| 50 | + suggested_reviewers: true |
| 51 | + auto_assign_reviewers: false |
| 52 | + |
| 53 | + # Keep the poem feature for team morale |
| 54 | + poem: true |
| 55 | + |
| 56 | + # Path filters - focus on source code and important config files |
| 57 | + path_filters: |
| 58 | + # Include source code and tests |
| 59 | + - "cmd/**" |
| 60 | + - "internal/**" |
| 61 | + - "**/*.go" |
| 62 | + - "**/*_test.go" |
| 63 | + |
| 64 | + # Include important configuration files |
| 65 | + - "go.mod" |
| 66 | + - "go.sum" |
| 67 | + - "Dockerfile*" |
| 68 | + - "*.dockerfile" |
| 69 | + - "Taskfile.yaml" |
| 70 | + - "*.yaml" |
| 71 | + - "*.yml" |
| 72 | + - "*.md" |
| 73 | + |
| 74 | + # Exclude build artifacts, binaries, and temporary files |
| 75 | + - "!bin/**" |
| 76 | + - "!*.exe" |
| 77 | + - "!*.test.exe" |
| 78 | + - "!dist/**" |
| 79 | + - "!build/**" |
| 80 | + - "!.git/**" |
| 81 | + - "!vendor/**" |
| 82 | + - "!*.log" |
| 83 | + - "!*.tmp" |
| 84 | + |
| 85 | + # Path-based instructions for better context-aware reviews |
| 86 | + path_instructions: |
| 87 | + - path: "**/*.go" |
| 88 | + instructions: "Focus on Go best practices, error handling, concurrency safety, performance, and security. Check for proper resource cleanup and context handling." |
| 89 | + |
| 90 | + - path: "**/*_test.go" |
| 91 | + instructions: "Ensure comprehensive test coverage, proper test isolation, meaningful assertions, and good test naming conventions." |
| 92 | + |
| 93 | + - path: "internal/reportportal/**" |
| 94 | + instructions: "Pay special attention to API integration patterns, error handling, data validation, and MCP protocol compliance." |
| 95 | + |
| 96 | + - path: "cmd/**" |
| 97 | + instructions: "Review CLI interface design, configuration handling, and application startup logic for robustness and usability." |
| 98 | + |
| 99 | + - path: "**/Dockerfile*" |
| 100 | + instructions: "Focus on security best practices, image size optimization, proper layering, and multi-stage builds where appropriate." |
| 101 | + |
| 102 | + # Tool configuration - enable Go and security-focused tools |
| 103 | + tools: |
| 104 | + # Go-specific linting |
| 105 | + golangci-lint: |
| 106 | + enabled: true |
| 107 | + |
| 108 | + # Security scanning |
| 109 | + gitleaks: |
| 110 | + enabled: true |
| 111 | + semgrep: |
| 112 | + enabled: true |
| 113 | + |
| 114 | + # Docker best practices |
| 115 | + hadolint: |
| 116 | + enabled: true |
| 117 | + |
| 118 | + # YAML validation for config files |
| 119 | + yamllint: |
| 120 | + enabled: true |
| 121 | + |
| 122 | + # Auto-review configuration |
| 123 | + auto_review: |
| 124 | + enabled: true |
| 125 | + drafts: false |
| 126 | + base_branches: ["main", "master", "develop"] |
| 127 | + |
| 128 | + # Pre-merge checks for quality gates |
| 129 | + pre_merge_checks: |
| 130 | + title: |
| 131 | + mode: "warning" |
| 132 | + requirements: "Use descriptive titles. Consider conventional commit format for consistency." |
| 133 | + |
| 134 | + description: |
| 135 | + mode: "warning" |
| 136 | + requirements: "Include description for significant changes. Link to relevant issues when applicable." |
| 137 | + |
| 138 | +# ============================================================================= |
| 139 | +# KNOWLEDGE BASE CONFIGURATION |
| 140 | +# ============================================================================= |
| 141 | + |
| 142 | +knowledge_base: |
| 143 | + # Coding guidelines - scan for project-specific standards |
| 144 | + code_guidelines: |
| 145 | + enabled: true |
| 146 | + filePatterns: |
| 147 | + - "README.md" |
| 148 | + - "CONTRIBUTING.md" |
| 149 | + - "docs/**/*.md" |
| 150 | + |
| 151 | + # Use repository learnings for this specific project |
| 152 | + learnings: |
| 153 | + scope: "local" |
| 154 | + |
| 155 | + # Include repository issues for context |
| 156 | + issues: |
| 157 | + scope: "local" |
| 158 | + |
| 159 | + # Disable external integrations for this open source project |
| 160 | + jira: |
| 161 | + usage: "disabled" |
| 162 | + |
| 163 | + linear: |
| 164 | + usage: "disabled" |
| 165 | + |
| 166 | + # Include PR history for better context |
| 167 | + pull_requests: |
| 168 | + scope: "local" |
| 169 | + |
| 170 | + # MCP integration (relevant for this project) |
| 171 | + mcp: |
| 172 | + usage: "auto" |
| 173 | + disabled_servers: [] |
| 174 | + |
| 175 | +# ============================================================================= |
| 176 | +# CODE GENERATION SETTINGS |
| 177 | +# ============================================================================= |
| 178 | + |
| 179 | +code_generation: |
| 180 | + # Docstring generation for Go code |
| 181 | + docstrings: |
| 182 | + language: "en-US" |
| 183 | + path_instructions: |
| 184 | + - path: "**/*.go" |
| 185 | + instructions: "Generate Go-style comments. Use proper godoc format with complete sentences. Include examples for public APIs when helpful." |
| 186 | + |
| 187 | + - path: "internal/**/*.go" |
| 188 | + instructions: "Focus on internal API documentation, explaining business logic and integration patterns." |
| 189 | + |
| 190 | + # Unit test generation guidelines |
| 191 | + unit_tests: |
| 192 | + path_instructions: |
| 193 | + - path: "**/*.go" |
| 194 | + instructions: "Generate comprehensive Go tests using testify/assert. Include table-driven tests where appropriate. Test error conditions and edge cases." |
| 195 | + |
| 196 | + - path: "internal/reportportal/**/*.go" |
| 197 | + instructions: "Focus on testing API integrations, error handling, and data transformation logic. Mock external dependencies properly." |
0 commit comments