Status Checks (GitHub)

GitHub status checks are indicators that appear on pull requests and commits to show whether specific conditions or requirements have been met. In the context of code quality, status checks provide immediate visual feedback about whether code meets established standards, including test coverage requirements.

How GitHub Status Checks Work

Status checks operate through GitHub's API and typically follow this process:

1. Triggering: A new commit or pull request activates external services via webhooks
2. Processing: The external service (like OtterWise) analyzes the code based on predefined criteria
3. Reporting: The service sends results back to GitHub via the Status API
4. Display: GitHub shows the status (pending, success, failure, or error) with a descriptive message
5. Enforcement: When combined with branch protection, status checks can prevent merging until requirements are met

Types of Status Checks

GitHub supports several categories of status checks:

• CI/CD Checks: Verify that builds and tests pass
• Code Quality Checks: Assess whether code meets quality standards
• Security Checks: Scan for vulnerabilities or security issues
• Deployment Checks: Confirm that deployment previews are available
• Custom Checks: Any specialized verification process relevant to a project

OtterWise Status Checks

OtterWise provides three specific status checks for monitoring code coverage:

• Code Coverage: Indicates whether the overall code coverage percentage meets the configured minimum threshold
• Patch Coverage: Shows whether the coverage for changed lines in the commit or PR meets the minimum patch coverage threshold
• Coverage Change: Reports whether the change in coverage compared to the base branch falls within acceptable limits

Branch Protection with Status Checks

Status checks become particularly powerful when combined with GitHub's branch protection rules:

• Required Checks: Designate specific checks that must pass before merging
• Up-to-Date Requirement: Ensure branches are updated with the latest base branch changes
• Administrator Override: Control whether repository administrators can bypass requirements
• Dismissal Rules: Define when approved reviews are dismissed by new commits
• Enforcement Level: Apply rules to all users or exclude specific users or teams

Benefits of Status Checks

Using status checks in your workflow offers several advantages:

• Automated Quality Control: Enforce standards without manual verification
• Visible Feedback: Provide clear indicators of code quality directly in GitHub
• Process Enforcement: Ensure development practices align with team standards
• Reduced Review Burden: Automatically catch issues before human review
• Consistent Standards: Apply the same quality criteria across all contributions
• Objective Evaluation: Base approvals on measurable criteria rather than subjective judgment

Configuring OtterWise Status Checks

To set up OtterWise status checks:

1. Enable Status Checks: In your repository settings on OtterWise, toggle "Use status checks" to enable
2. Configure Thresholds: Set the minimum coverage, minimum patch coverage, and maximum allowable decrease
3. Set Up Branch Protection: In GitHub repository settings, create rules that require the OtterWise status checks
4. Select Required Checks: Choose which specific status checks must pass before merging

Status Check Context

When looking at GitHub status checks from OtterWise, you'll see them identified by these contexts:

• Code Coverage: PR (or Code Coverage: Commit): For overall coverage
• Code Coverage: Patch: For coverage of changed lines
• Code Coverage: Change: For the difference in coverage percentage

Best Practices for Status Checks

To get the most value from status checks:

• Start with Reasonable Thresholds: Begin with achievable standards, especially for existing projects
• Gradually Increase Requirements: Raise thresholds over time as code quality improves
• Focus on Patch Coverage: Prioritize high coverage for new code even if legacy code has gaps
• Document Exceptions: Create clear guidelines for when exceptions to status check requirements are permitted
• Monitor Feedback: Adjust thresholds based on team feedback and development velocity

Status checks transform code quality from an aspiration into an enforceable requirement. By integrating OtterWise's status checks into your GitHub workflow, you create a system that consistently maintains and improves coverage standards across your codebase.