Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

🛠 Tooling: Code coverage is underreported? #692

Closed
3 tasks done
JoshuaKGoldberg opened this issue Aug 23, 2023 · 3 comments · Fixed by #693
Closed
3 tasks done

🛠 Tooling: Code coverage is underreported? #692

JoshuaKGoldberg opened this issue Aug 23, 2023 · 3 comments · Fixed by #693
Assignees
@JoshuaKGoldberg
Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Overview

Right now, this package uses Codecov to store and track code coverage from tests over time. Test coverage is merged in Codecov between:

When I view the coverage/index.html generated by pnpm run test run --coverage locally, it shows many lines of many files covered. For example, src/shared/doesRepositoryExist.ts is marked as fully covered:

Coverage report of doesRepositoryExist.ts contents showing all green (covered)

However, when I view src/shared/doesRepositoryExist.ts in Codecov, many lines are marked as uncovered:

Codecov coverage of doesRepositoryExist.ts showing 48.15% coverage. Lines 8-13, 16-18, 20, 23-24, and 26-27 are red (uncovered)

What's going on here? Is it that the coverage providers are different?

Additional Info

No response
@JoshuaKGoldberg JoshuaKGoldberg added type: bug Something isn't working :( area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! labels Aug 23, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Aug 23, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Aug 23, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Aug 23, 2023
@JoshuaKGoldberg
chore: also mention GitHub apps in creation (#693)
a944257 
## PR Checklist

- [x] Addresses an existing open issue: fixes #692
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

Skips using istanbul, in favor of v8. I'm hoping using the same coverage
report format will help Codecov figure things out. Note that this now
triggers vitest-dev/vitest#3605 issue of v8
counting types as untested.
@JoshuaKGoldberg
Copy link
Owner Author

Yeah, #693 showed that this is a Codecov report merging issue. Switching the only istanbul report to v8 helped get the merging all correct.

This isn't ideal because v8 doesn't handle type-only TypeScript constructs as well (vitest-dev/vitest#3605).

@JoshuaKGoldberg
Copy link
Owner Author

Ah, tracked in istanbuljs/istanbuljs#531.

@github-actions
Copy link

🎉 This is included in version v1.29.4 🎉

The release is available on:

Cheers! 📦🚀

@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Sep 2, 2023
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: also mention GitHub apps in creation JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg