Skip to content

[BUG] CodeCov badge in the README doesn't display any useful info ATM #319

@kami619

Description

@kami619

Bug Description

The Codecov badge in the README displays a failing or unknown status, even though CI tests are passing. This affects the project's perceived health on the repository landing page.

Badge URL in README:

[![codecov](https://codecov.io/gh/ambient-code/agentready/branch/main/graph/badge.svg)](https://codecov.io/gh/ambient-code/agentready)

To Reproduce

  1. Go to https://github.com/ambient-code/agentready
  2. View the README badges section
  3. Observe the Codecov badge status

Expected Behavior

The Codecov badge should display current coverage percentage (e.g., "85%") or at minimum show a valid state linked to the latest CI run.

Actual Behavior

The badge shows a failing/unknown state despite CI being green.

Environment

  • Repository: ambient-code/agentready
  • Badge Type: Codecov SVG badge
  • Branch: main

Additional Context

Possible causes:

  1. Codecov integration not configured - The repository may not have Codecov enabled or the CODECOV_TOKEN secret may be missing
  2. Coverage not being uploaded - CI workflow may not include a step to upload coverage reports to Codecov
  3. Codecov project not linked - The Codecov project may not exist or may not be linked to this GitHub repository

Possible Solution

Option A: Configure Codecov integration

  1. Sign in to codecov.io with GitHub
  2. Enable the ambient-code/agentready repository
  3. Add CODECOV_TOKEN as a repository secret
  4. Add coverage upload step to CI workflow:
    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@v4
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
        files: ./coverage.xml
        fail_ci_if_error: false

Option B: Remove the badge
If Codecov integration is not desired, remove the badge from the README to avoid displaying misleading status.

Option C: Use alternative coverage badge
Use a different coverage reporting service that's already configured, or use a static badge until Codecov is properly set up.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions