Skip to content

docs: add Codecov coverage badge to README#4714

Merged
Yicong-Huang merged 2 commits into
apache:mainfrom
Yicong-Huang:docs/readme-codecov-badge
May 3, 2026
Merged

docs: add Codecov coverage badge to README#4714
Yicong-Huang merged 2 commits into
apache:mainfrom
Yicong-Huang:docs/readme-codecov-badge

Conversation

@Yicong-Huang
Copy link
Copy Markdown
Contributor

@Yicong-Huang Yicong-Huang commented May 3, 2026

What changes were proposed in this PR?

Add a Codecov coverage badge to the existing <p align="center"> stats block in README.md. The badge links to https://app.codecov.io/gh/apache/texera so reviewers / contributors can see the current overall coverage and click through to the per-flag breakdown without leaving the repo home page.

CleanShot 2026-05-02 at 17 31 13

Any related issues, documentation, discussions?

Closes #4713.

How was this PR tested?

This is a one-line README change; rendered the new line in the GitHub markdown preview locally. The badge URL is already producing a non-unknown value (the dashboard returns 46% for the latest main commits), so the rendered badge will be a real number on first view, not the placeholder.

Was this PR authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Opus 4.7, 1M context)

PR apache#4666 wired CODECOV_TOKEN so push events on main and release/**
upload coverage. Surface that on the repo home page so readers can
get to the dashboard in one click; flags (frontend / scala / python /
agent-service) are broken out on the Codecov side.

Closes apache#4713.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added the docs Changes related to documentations label May 3, 2026
@Yicong-Huang Yicong-Huang requested a review from chenlica May 3, 2026 00:30
@Yicong-Huang Yicong-Huang enabled auto-merge (squash) May 3, 2026 00:30
Copy link
Copy Markdown
Contributor

@chenlica chenlica left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@Yicong-Huang Yicong-Huang added the release/v1.1.0-incubating back porting to release/v1.1.0-incubating label May 3, 2026
@Yicong-Huang Yicong-Huang merged commit 09715e1 into apache:main May 3, 2026
25 checks passed
Yicong-Huang added a commit that referenced this pull request May 3, 2026
### What changes were proposed in this PR?

Add a Codecov coverage badge to the existing `<p align="center">` stats
block in `README.md`. The badge links to
https://app.codecov.io/gh/apache/texera so reviewers / contributors can
see the current overall coverage and click through to the per-flag
breakdown without leaving the repo home page.

```diff
   <img alt="Static Badge" src="https://img.shields.io/badge/Largest_Deployment-100_nodes,_400_cores-green">
+  <a href="https://app.codecov.io/gh/apache/texera"><img alt="Coverage" src="https://img.shields.io/codecov/c/github/apache/texera/main?logo=codecov&label=coverage"></a>
 </p>
```

Why now: PR #4666 wired `CODECOV_TOKEN` so push events on `main` and
`release/**` now upload coverage. The latest few main commits at
`https://codecov.io/api/v2/github/apache/repos/texera/branches/main` are
reporting `46%` overall (frontend / scala / python / agent-service flags
broken out). Without the badge, every "what's the current coverage?"
question is a manual hop to the Codecov dashboard.

Style note: shields.io to match the neighboring `Static Badge` images.
Linked so a click jumps straight to the dashboard (the existing badges
are images-only).

### Any related issues, documentation, discussions?

Closes #4713. Related: #4666 (Phase 2 token wiring), #4645 (Phase 1
tokenless wiring).

### How was this PR tested?

This is a one-line README change; rendered the new line in the GitHub
markdown preview locally. The badge URL is already producing a
non-`unknown` value (the dashboard returns `46%` for the latest main
commits), so the rendered badge will be a real number on first view, not
the placeholder.

### Was this PR authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Opus 4.7, 1M context)

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

(backported from commit 09715e1)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Changes related to documentations release/v1.1.0-incubating back porting to release/v1.1.0-incubating

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Codecov coverage badge to README

2 participants