Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.58 KB

CONFIGURATION.md

File metadata and controls

34 lines (25 loc) · 1.58 KB

Configuration Guide

Code Coverage Setup

This repository uses CodeClimate for code coverage and maintainability reporting.

Required Setup Steps

In CodeClimate:

  1. Enable CodeClimate for the repository
  2. Enable "Pull Request Status Updates" in Repo Settings > GitHub
  3. Enable Test Coverage and Maintainability checks

In GitHub:

  1. Add CC_TEST_REPORTER_ID to GitHub Actions secrets
  2. Ensure Actions have "Read and write permissions" under repository Settings > Actions > General
  3. Enable branch protection for the following status checks:
    • codeclimate/test-coverage
    • codeclimate/maintainability

Verification

After setup, CodeClimate will:

  • Run on every PR and push to main
  • Post coverage reports as PR comments
  • Show coverage changes inline with code changes
  • Block PR merging if coverage drops below configured thresholds (if set)

Troubleshooting

If coverage reports are not appearing:

  1. Verify the CC_TEST_REPORTER_ID is correctly set
  2. Check GitHub Actions logs for any coverage upload errors
  3. Ensure the repository is properly connected in CodeClimate's UI