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.

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

Incorporate coverage diff reporting #301

Closed
3 tasks
thekaveman opened this issue Aug 16, 2023 · 0 comments · Fixed by #379
Closed
3 tasks

Incorporate coverage diff reporting #301

thekaveman opened this issue Aug 16, 2023 · 0 comments · Fixed by #379
Assignees
Labels
actions Related to GitHub Actions workflows tests Related to automated testing (unit, integration, etc.)

Comments

@thekaveman
Copy link
Member

We use the coverage package to calculate Python unit test coverage of the codebase.

When the tests are run in CI, we generate a coverage report, but this doesn't go anywhere and isn't a very useful output for us.

Within a given PR or set of changes, we want more insight of the impact on test coverage -- without manually reviewing coverage reports and eyeballing differences.

The Python Coverage Comment GitHub Action can be used in a workflow to provide coverage diffs for our pytests. The action uses existing coverage metadata generated by the test runner to create a PR comment with information about the change. The comment is updated as the PR changes and new test runs are produced.

Example: comment on a first-time setup PR
image

Acceptance Criteria

Additional context

Corrollary to cal-itp/benefits#1668

Example of this setup

@thekaveman thekaveman added actions Related to GitHub Actions workflows tests Related to automated testing (unit, integration, etc.) labels Aug 16, 2023
@thekaveman thekaveman moved this from Todo to Stretch in Digital Services Aug 16, 2023
@thekaveman thekaveman moved this from Stretch to Todo in Digital Services Nov 29, 2023
@thekaveman thekaveman moved this from Todo to Stretch in Digital Services Nov 29, 2023
@thekaveman thekaveman self-assigned this Dec 5, 2023
@thekaveman thekaveman moved this from Stretch to In Progress in Digital Services Dec 5, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in Digital Services Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions Related to GitHub Actions workflows tests Related to automated testing (unit, integration, etc.)
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant