Add codecov step in CI and add badges to README #20
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #20 +/- ##
=======================================
Coverage ? 88.52%
=======================================
Files ? 52
Lines ? 7593
Branches ? 0
=======================================
Hits ? 6722
Misses ? 734
Partials ? 137 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
yuxincs
force-pushed
the
yuxincs/add-codecov
branch
from
f3686bb
to
d659714
Compare
yuxincs
force-pushed
the
yuxincs/add-codecov
branch
from
d659714
to
24aa6b5
Compare
lazaroclapp
approved these changes
Aug 4, 2023
.codecov.yaml
Outdated
| default: # context, you can create multiple ones with custom titles | ||
| enabled: yes # must be yes|true to enable this status | ||
| target: auto # specify the target coverage for each commit status | ||
| # option: "auto" (must increase from parent commit or pull request base) |
There was a problem hiding this comment.
Suggested change
| # option: "auto" (must increase from parent commit or pull request base) | |
| # option: "auto" (must not decrease from parent commit or pull request base) |
Right?
There was a problem hiding this comment.
Right, actually I found out that we can do auto with a threshold https://docs.codecov.com/docs/commit-status and I have set this to be 5%, meaning that the coverage cannot drop more than 5% (to also allow some flakiness).
Let me know if you think we should be stricter about this :)
lazaroclapp
approved these changes
Aug 4, 2023
sonalmahajan15
pushed a commit
that referenced
this pull request
Aug 5, 2023
This PR adds a codecov step in CI configs and add the corresponding badges to README. We have also added a config file for codecov to fail PRs if the coverage decreases (experimental, we can revert / disable it if it gets too annoying in the future)
sonalmahajan15
pushed a commit
that referenced
this pull request
Aug 7, 2023
In #20, we added Codecov integration by configuring the `project` rule to require overall project coverage to not decrease by more than 1% for every new PR. However, by default, Codecov configures two checks: `project` and `patch`. We were using the defaults for `patch`, which checks the coverage of the new lines in the PR. After internal discussion, we are choosing to disable `patch` level checking, for two reasons: 1. Flakiness around detecting "new code" in a PR in the presence of refactorings and code motion 2. To allow for small changes as part of a PR stack which e.g. add a new interface/type before implementing the corresponding functionality to be tested. We expect that, by default, most PRs will be gated by the `project` check, and that coverage will increase over time given the restrictions on reducing coverage. If this turns out to not be true over time, we can always make one or both of these checks stricter.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a codecov step in CI configs and add the corresponding badges to README.
We have also added a config file for codecov to fail PRs if the coverage decreases (experimental, we can revert / disable it if it gets too annoying in the future)