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

Feedback about the new pull request comment #8

Open
kylemann opened this issue Dec 17, 2021 · 50 comments
Open

Feedback about the new pull request comment #8

kylemann opened this issue Dec 17, 2021 · 50 comments

Comments

@kylemann
Copy link

Thanks for dropping by! 👋

We've been iterating and updating the layout, summary, and copy of the pull request comment.

  • What do you think about the changes?
  • What would you'd like to see improved?
  • What are challenges you've experienced with the report?
  • How do you use the comment today?
  • How could the report better help your workflow?
  • Any general thoughts you'd like to share!

We greatly appreciate your time and thoughts - looking forward to hearing from you ❤

Codecov team

This issue is intended to share and collect feedback about the tool. If you have support needs or questions, please see our support page.

@TechMaz
Copy link

TechMaz commented Feb 15, 2022

I think it's a great feature, but it can sometimes clog up a PR review screen, so it would be great if they were collapsible so that we can read the code around them more easily when desired.

@codecovdesign
Copy link

@TechMaz thank you for your feedback.
We are actually experimenting with a new layout, see below. It prioritizes the high level summary and then collapses the other reporting data (impacted files, table, etc).

Would love to hear your feedback 🙏

new_comment

@openrefactory
Copy link

@eliatcodecov
Please watch this issue we have open this issue one week ago still don't get any respond yet.

httpie/cli#1434

@daniellockyer
Copy link

I love it! It's so much cleaner and less obtuse <3

@unmade
Copy link

unmade commented Oct 5, 2022

I'm not sure how that's possible but pull request form shows me wrong coverage result - it says my pull request will decrease project coverage, although I'm confident my changes won't not affect coverage at all. I don't see that problem in the codecov web application.

I also compared coverage.xml files uploaded to codecov for corresponding commits and they're identical.

The pull request with wrong form:
unmade/shelf-back#97

Full report at codecov:
https://app.codecov.io/gh/unmade/shelf-back/pull/97

Screenshot 2022-10-05 at 22 22 19

And here's the coverage files for corresponding commits:

@nitram509
Copy link

Hi,

thanks for providing codecov tests to the Open Source community for free.
After adding some tests, I found your report reported lower coverage than before, when no test was there at all.
See argoproj/argo-rollouts#2303 (comment)

I do not trust the codecov report, because why it's going down when I literally create the first test file in this package?

PS: I just measured the test coverage of the new file created, this is 87% (according to IntelliJ).

@KnorpelSenf
Copy link

This may sound like a nitpick but the coverage diff has a sign error in the GitHub comment that the bot is posting. It says "coverage decreases by -3%" but decreasing by a negative amount would mean increasing. Perhaps it should say "coverage decreases: -3%" to make it more accurate?

@ssb22
Copy link

ssb22 commented Oct 29, 2022

On this pull request I simply added some lines to the documentation (README.md and README.rst), but CodeCov warned that code coverage had been reduced by my change. It would be nice if obvious documentation files didn't count. Thanks.

@mamil
Copy link

mamil commented Nov 21, 2022

Hi,

On this PR, I just copy an old case and then mod one function call, no tests were removed, and the test coverage decreased.

@sayo96
Copy link

sayo96 commented Dec 14, 2022

I'm unable to view the coverage report like before on the PR's. Codecov is such a big mess rn.

@codecovdesign
Copy link

"coverage decreases by -3%"...Perhaps it should say "coverage decreases: -3%" to make it more accurate?

Thank you, @KnorpelSenf that makes sense - will update text clarification in next iteration.

@codecovdesign
Copy link

unable to view the coverage report like before on the PR
@sayo96 it's a new PR layout we are testing. is there something specific that you noticed and/or preferred to see that was in the the previous comment?

@PaulRBerg
Copy link

PaulRBerg commented Feb 7, 2023

Is it possible to disable the automatic comments?

We'd like to keep using the Codecov GitHub app (so that our codecov.yml file gets synced with Codecov) but not receive the PR comments.

Update: it looks like comments can be disabled by adding comment: false in the Codecov config.

@slifty
Copy link

slifty commented Feb 14, 2023

Is it possible to manually request that codecov re-run the report? I've found the most spotty aspect of codecov in our development workflow to be when we force push to a branch with new test coverage but codecov doesn't update the statistics.

It would be great to be able to basically say "@codecov rerun" or something along those lines in the PR.

@ntindle
Copy link

ntindle commented Apr 25, 2023

Hey! Over at https://github.com/Significant-Gravitas/Auto-GPT/, we are running into some severe problems with CodeCov. We tried reaching out to a rep and getting some of it worked out and a demo, but they were unavailable at our scheduled time. We liked CodeCov, but it currently needs fixing and denying all PRs. I don't particularly want to swap providers, but hundreds of people are asking us why CodeCov is broken, and we need help finding answers. I would love a reply as soon as you can

@borislavnnikolov
Copy link

What about the StateHasChanged implementation for the other components, like MudTabs and etc. ?

@webbnh
Copy link

webbnh commented May 5, 2023

The pull request comment seems good to me (I'm just starting with Codecov), but there seems to be a bootstrap problem which I describe here: when there is nothing to compare to (because the base commit doesn't have any code in it yet), it's treated as a error situation instead of as though all the changes are new code (which...they are 😁).

Once my PR is merged, we'll presumably never encounter the situation again, so perhaps it's not real important, but fixing it would improve the user's on-boarding experience, and it doesn't seem like it would be that hard to address.

@codecovdesign
Copy link

@webbnh thank you for your feedback!

Once my PR is merged, we'll presumably never encounter the situation again, so perhaps it's not real important, but fixing it would improve the user's on-boarding experience

💯 that's right, the comment has a missing base report and looks like an error 🙉 . We are actively looking to have the 1st comment more welcoming and clear as seen below. If you have any thoughts or revisions you'd make let me know!

1st_time_ux

@iselo
Copy link

iselo commented Jul 15, 2023

Let's do the math!)
Screen Shot 2023-07-15 at 3 59 46 PM

@KnorpelSenf
Copy link

KnorpelSenf commented Jul 16, 2023

Those are rounded numbers, so it could have gone down by 0.008 from 99.614 to 99.606 which would be rounded to 0.01 from 99.61 to 99.61. Perhaps we would want the diff to operate based on the rounded absolute values, but that could effectively hide a decrease in test coverage.

@webbnh
Copy link

webbnh commented Jul 18, 2023

Explicit rounding aside, floating point math is much harder than it seems. (Any time you see a decimal point in the middle of the number, assume that anything to the right of it is "an estimate"! 😁)

@karfau
Copy link

karfau commented Oct 4, 2023

image
I took me a while to understand that this means the current run that uploads the report has not completed yet.

I would suggest to make this more obvious by changing the wording to something like

This the last uploaded report is for commit 1234567 but the latest commit for this PR is 4567890, this comment will be updated as soon as the report for that commit has been uploaded.

@zimeg
Copy link

zimeg commented Nov 28, 2023

👋 Hey there, big fan of PR comments and y'alls coverage checks in general! Really appreciate this place for feedback!

A recent change might have moved the `diff` into a details section with `files` being shown at the top level patch

Previously only the diff was shown with the same header and footer, without the specifics on files. I preferred that approach since it focused more on improving coverage in the patch instead of missing coverage1.

I found a section in the docs on changing this layout and was wondering if the comment example2 is accurate with the dropdown above? The codecov.yml used in the comment's project has no layout section at the moment.

Also wondering how adding condensed_ changes the comment layout? I'll probably try out a few different options soon but it's not super clear to me right now. Thanks for all of the great features! 🙌

Footnotes

  1. 😉 💚 https://about.codecov.io/blog/the-case-against-100-code-coverage/

  2. Small note, there's an extra space before the hide_project_coverage field

@rohan-at-sentry
Copy link

rohan-at-sentry commented Nov 28, 2023

👋 Hey there, big fan of PR comments and y'alls coverage checks in general! Really appreciate this place for feedback!

A recent change might have moved the diff into a details section with files being shown at the top level
Previously only the diff was shown with the same header and footer, without the specifics on files. I preferred that approach since it focused more on improving coverage in the patch instead of missing coverage1.

I found a section in the docs on changing this layout and was wondering if the comment example2 is accurate with the dropdown above? The codecov.yml used in the comment's project has no layout section at the moment.

Also wondering how adding condensed_ changes the comment layout? I'll probably try out a few different options soon but it's not super clear to me right now. Thanks for all of the great features! 🙌

Footnotes

  1. 😉 💚 https://about.codecov.io/blog/the-case-against-100-code-coverage/
  2. Small note, there's an extra space before the hide_project_coverage field

@zimeg thanks for the detailed feedback here 👍🏽

You can bring back the older view by adding the following to your codecov.yml

layout: " header, diff, files, footer"

However, since you're open to it, I'd encourage experimenting with the options a little bit; there's a lot of good stuff in the new changes that I'm sure you'd benefit from.

Adding condensed_ accomplishes the following for each element

  • condensed_header : updated verbiage to be more concise.
  • condensed_diff : is more verbose - giving you coverage "diff" between current and last commit for which we have coverage
  • condensed_files : is now furled by default, which is largely driven by feedback we've historically received about the PR comment being large

@shlomi-noach
Copy link

shlomi-noach commented Jan 17, 2024

In this report, codecov tells me that there is 1 line missing coverage in my change:

image

However, clicking 1 missing, or any other link, only leads me to the full coverage breakdown of throttler.go, nothing to show me what specific 1 line was missing coverage in my change.

Link to OSS vitessio/vitess PR comment: vitessio/vitess#14971 (comment)

@EverWinter23
Copy link

It pollutes the entire PR, I cannot review the diff. Cause it pulls in unnecessary lines-of-code as well. This was not well thought out from UX point of view, I want to disable codecov just to get rid of the comments.

@codecovdesign
Copy link

@EverWinter23 thanks for the feedback, was hoping you could expand on it:

it pulls in unnecessary lines-of-code as well.

Do you have a screenshot of what your referring to? Any additional details can really help the team improve the format. Thank you 🙏

@donhcd
Copy link

donhcd commented Feb 12, 2024

I'm getting a failing symbol ❌ in my PR checks
image
even though the comment on the same PR has a ✅ on it
image

ever since we introduced codecov to our project, probably 75+% of our PRs have had ❌s on them, probably due to this class of issue. In this specific case, my PR only affects github actions files -- why is codecov ❌ing me?

@thomasrockhu-codecov
Copy link
Contributor

@donhcd can you provide a link to your PR or a commit SHA?

@nhorton
Copy link

nhorton commented Feb 20, 2024

Meta request: The way this solicitation of feedback is linked in the comment means that anything that syncs comments to places with previews (like Slack) results in a giant blob about this feedback request in those channels. If you made this go through a link shortener or such to break the preview, it would be really nice.

@naik-aakash
Copy link

naik-aakash commented Feb 26, 2024

The codecov report is bit inconsistent with on different runs for same test set.

https://github.com/JaGeo/LobsterPy/commits/main/

@thomasrockhu-codecov
Copy link
Contributor

@naik-aakash can you be a little more specific about that? Which commits for example? Do you mean that the coverage results are different or that the PR comment format is different? Screenshots would be helpful as well.

@naik-aakash
Copy link

naik-aakash commented Feb 26, 2024

@naik-aakash can you be a little more specific about that? Which commits for example? Do you mean that the coverage results are different or that the PR comment format is different? Screenshots would be helpful as well.

Yes, sure, sorry. Coverage results are different with multiple runs. I suspect it had to do with layout_dicts.py file formatting now. Not entirely sure that was root cause for this or not.

Here is the PR where you can see the inconsistency.

JaGeo/LobsterPy#245

@HarelM
Copy link

HarelM commented Feb 29, 2024

I'm not sure if this is only me reading this incorrectly, but I'm having a hard time truly understanding the difference between the PR comment and the report itself, they don't seem to be aligned:
Relevant PR: maplibre/maplibre-gl-js#3645
Screenshot of current comment:
image
Screenshot of the report in codecov:
image

The number of missed lines is not the same.
The patch percentage is not the same.
I'm not sure which one of them should I trust... :-/

@codecovdesign
Copy link

@HarelM thank you for the detailed report 🙏
I'm not sure what's happening here, but the results are clearly different.
Our team is investigating it, created a bug report: codecov/engineering-team#1321
Thanks again for sharing!

@dabrahams
Copy link

Is there a way to make codecov not send the report when all is well? I really only want to hear about failures. Thanks!

@HarelM
Copy link

HarelM commented Mar 7, 2024

It's also worth noting the following experience:
The above library that I linked is sending multiple coverage files since some of the tests run on different workers in parallel.
Codecov will create a coverage comment when the first file al finishes processing, so I get a mail notifying me with wrong coverage. In most cases this coverage comment will be updated although I've seen cases where it didn't.
I would consider posting the coverage comment only when all the runners complete.

I know our use case might be complicated, but coverage is very important to our project, I've done a lot of tweaking to be able to measure coverage correctly.

@codecovdesign
Copy link

Is there a way to make codecov not send the report when all is well? I really only want to hear about failures.

@dabrahams there is this configuration that will only show if ANY changes occur. That doesn't quite acheive your ask though. cc'ing @thomasrockhu-codecov @drazisil-codecov are you familiar with another configuration to resolve this?

Created an issue to look at this more / adding ability to show only with negative reporting: codecov/engineering-team#1350; please add any thoughts/comments you have.

@codecovdesign
Copy link

codecovdesign commented Mar 7, 2024

I get a mail notifying me with wrong coverage

@HarelM it may help to apply after_n_buid here, do you have this set? It will wait until that many reports are complete to update the comment. EDIT: adding issue to look at this further: codecov/engineering-team#1352

@HarelM
Copy link

HarelM commented Mar 7, 2024

Ah, didn't know about this option, I'll try it out, thanks!

@HarelM
Copy link

HarelM commented Mar 13, 2024

@codecovdesign I don't see the specified flag in the github action parameters here:
https://github.com/codecov/codecov-action
Am I missing anything?

@codecovdesign
Copy link

@HarelM if updating flags you'll want to do this in the codecov.yaml https://docs.codecov.com/docs/flags#step-2-flag-management-in-yaml

@HarelM
Copy link

HarelM commented Mar 25, 2024

@codecovdesign is there a way to do it without introducing a whole new file to my repo in order to send a single flag to codecov? Is it possible to support the most common flag (or better yet all of them) in the github action configuration? I'm managing most of my CI configuration in this file anyway, it would be great to be able to simply add with: something or add some environment variables that the action will take into consideration.

@codecov codecov deleted a comment Mar 26, 2024
@codecov codecov deleted a comment Mar 26, 2024
@HarelM
Copy link

HarelM commented Apr 10, 2024

There's a bug that's preventing from getting accurate report due to the fact that it takes too many files (not the files I specifically requested):
The following is the relevant bug:
codecov/codecov-action#1354
I think it can be considered a critical bug...
Also I think that draft PR do not get coverage report due to some github API usage in codecov as far as I saw in the action run logs...

@codecovdesign
Copy link

@HarelM sorry missed this one; @drazisil-codecov and I were just looking at it and were unsure exactly. would you be up for a call? if so, shoot me an email at kyle.mann@sentry.io and will find a time. curious to learn more about your use case too.

@HarelM
Copy link

HarelM commented Apr 11, 2024

I've sent a mail to see when we can meet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Waiting for: Product Owner
Development

No branches or pull requests