Skip to content

🛠 Tooling: Add instrumentation to repo end-to-end tests #472

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.

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

Closed
3 tasks done
JoshuaKGoldberg opened this issue May 22, 2023 · 2 comments · Fixed by #473
Closed
3 tasks done

🛠 Tooling: Add instrumentation to repo end-to-end tests #472

JoshuaKGoldberg opened this issue May 22, 2023 · 2 comments · Fixed by #473
Labels
area: testing Improving how the repository's tests are run and/or code is tested status: accepting prs Please, send a pull request to resolve this!

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

#441 (src/setup) and #469 (src/hydrate) both added a bunch of code under src/, without fully unit testing that code. They have followup issues for adding more unit tests: #447 and #471, respectively.

But! The src/hydrate/index.ts and src/setup/index.ts scripts, despite not being unit tested, are end-to-end tested: pnpm run hydrate:test and pnpm run setup:test, respectively. So I'd consider those lines as covered... even though Codecov doesn't think so.

Screenshot of "coverage: 31%" readme badge with an orange/red flair background

So in theory this repository could:

  1. Augment the pnpm run hydrate:test and pnpm run setup:test commands to generate code coverage reports
  2. Use Codecov coverage report merging to merge reports for calculation

It'd be really nice to get that code coverage report on the README.md to the high number it deserves to be! 💚

Additional Info

No response

@JoshuaKGoldberg JoshuaKGoldberg added status: accepting prs Please, send a pull request to resolve this! area: testing Improving how the repository's tests are run and/or code is tested labels May 22, 2023
JoshuaKGoldberg added a commit that referenced this issue May 22, 2023
<!-- 👋 Hi, thanks for sending a PR to template-typescript-node-package!
💖.
Please fill out all fields below and make sure each item is true and [x]
checked.
Otherwise we may not be able to review your PR. -->

## PR Checklist

- [x] Addresses an existing open issue: fixes #472
- [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

Again uses the
[codecov/codecov-action](https://github.com/codecov/codecov-action) to
store coverage reports, this time from `coverage-hydrate` and
`coverage-setup`.

For convenience, all coverage reports are stored in GitHub Actions
(https://docs.github.com/en/actions/using-workflows/storing-workflow-data-as-artifacts).
@github-actions
Copy link

github-actions bot commented Jun 2, 2023

🎉 This is included in version v1.28.1 🎉

The release is available on:

Cheers! 📦🚀

1 similar comment
@github-actions
Copy link

github-actions bot commented Jun 2, 2023

🎉 This is included in version v1.28.1 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: testing Improving how the repository's tests are run and/or code is tested status: accepting prs Please, send a pull request to resolve this!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant