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

fix incorrect codecov reports #6553

Merged
merged 1 commit into from
Aug 18, 2020
Merged

fix incorrect codecov reports #6553

merged 1 commit into from
Aug 18, 2020

Conversation

stas00
Copy link
Contributor

@stas00 stas00 commented Aug 18, 2020

As discussed at #6317 codecov currently sends an invalid report when it fails to find a code coverage report for the base it checks against. When this happens it goes looking for the nearest hash with report, which often leads to a report that is not representative of the true impact of the proposed PR.

This PR fixes it by adding:

require_base: yes # don't report if there is no base coverage report

And then:

  • let's add this for clarity, this supposedly is already the default.

    require_head: yes # don't report if there is no head coverage report

  • and perhaps no point reporting on doc changes as they don't make any difference to the coverage and the 0% change comment just generates noise:

    require_changes: true # only comment if there was a change in coverage

These options are documented here: https://docs.codecov.io/docs/codecovyml-reference#comment

As discussed at huggingface#6317 codecov currently sends an invalid report when it fails to find a code coverage report for the base it checks against, so this gets fixed by:

-  require_base: yes        # don't report if there is no base coverage report

let's add this for clarity, this supposedly is already the default.

-  require_head: yes        # don't report if there is no head coverage report 

and perhaps no point reporting on doc changes as they don't make any difference and it just generates noise:

-  require_changes: true    # only comment if there was change in coverage
Copy link
Collaborator

@sgugger sgugger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me! Let's give it a try and see if codecov reports are less of a joke.

@sshleifer sshleifer merged commit 7659a8e into huggingface:master Aug 18, 2020
@stas00 stas00 deleted the patch-1 branch August 18, 2020 17:25
@LysandreJik
Copy link
Member

Great, thanks for diving into it @stas00!

@stas00
Copy link
Contributor Author

stas00 commented Aug 24, 2020

Alas, it solved only part of the problem - the main issue is still there #6553 :(

Zigur pushed a commit to Zigur/transformers that referenced this pull request Oct 26, 2020
As discussed at huggingface#6317 codecov currently sends an invalid report when it fails to find a code coverage report for the base it checks against, so this gets fixed by:

-  require_base: yes        # don't report if there is no base coverage report

let's add this for clarity, this supposedly is already the default.

-  require_head: yes        # don't report if there is no head coverage report 

and perhaps no point reporting on doc changes as they don't make any difference and it just generates noise:

-  require_changes: true    # only comment if there was change in coverage
fabiocapsouza pushed a commit to fabiocapsouza/transformers that referenced this pull request Nov 15, 2020
As discussed at huggingface#6317 codecov currently sends an invalid report when it fails to find a code coverage report for the base it checks against, so this gets fixed by:

-  require_base: yes        # don't report if there is no base coverage report

let's add this for clarity, this supposedly is already the default.

-  require_head: yes        # don't report if there is no head coverage report 

and perhaps no point reporting on doc changes as they don't make any difference and it just generates noise:

-  require_changes: true    # only comment if there was change in coverage
fabiocapsouza added a commit to fabiocapsouza/transformers that referenced this pull request Nov 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants