Introduction
OtterWise can automatically add comments to your GitHub pull requests that include detailed coverage metrics and analysis. These comments provide valuable insights directly in your PR workflow, making it easier to maintain and improve code quality.
Enabling PR Comments
PR comments can be enabled or disabled on a per-repository basis. To enable this feature:
- Navigate to your repository in OtterWise
- Click on the "Settings" tab
- Scroll to the "Pull Request Settings" section
- Toggle the "Send comment" option to enable PR comments
OtterWise Otto Bot
PR comments are posted by the OtterWise Otto bot user. For optimal setup, we recommend installing the OtterWise GitHub App to use our official bot account for comments.
Recommendation
Install the OtterWise GitHub App to get the best experience with PR comments. This gives us a dedicated bot user that won't be affected if individual team members leave the organization.
Comment Content
Each comment includes comprehensive coverage information:
- Overall Coverage Status: Shows the current coverage percentage
- Coverage Change: Indicates how coverage has changed compared to the base branch
- Patch Coverage: Displays how many of the changed lines in the PR are covered by tests
-
Detailed Metrics (in collapsible section):
- Coverage breakdown (files, lines, hits, misses)
- Complexity metrics
- CRAP (Change Risk Anti-Patterns) score
- Files with reduced coverage (if any)
- Link to Full Report: Direct access to detailed coverage analysis in OtterWise
Automatic Updates
Comments are automatically updated when new commits are pushed to the PR. This ensures your team always has the most current coverage information without cluttering the PR with multiple comments.
Warning Indicators
The PR comment will display warning indicators for various scenarios:
- Base Branch Differences: When there's a difference between the base branch and PR base
- Coverage Threshold Issues: When coverage falls below your configured minimum threshold
- Base SHA Issues: When there are issues with the base commit reference
Warning Example
When coverage drops below threshold, you'll see:
Warning
Code coverage is 75.4%, which is lower than the set minimum threshold of 80.0%.
Using with Other GitHub Features
PR comments work well alongside these other OtterWise features:
- Status Checks: For enforcing coverage thresholds
- Line Annotations: For highlighting specific uncovered lines
Combined, these features provide a comprehensive code quality review system directly in your GitHub workflow.
