supervision icon indicating copy to clipboard operation
supervision copied to clipboard

ci(coverage): ๐Ÿงช initial code-coverage CI added and package include into toml

Open onuralpszr opened this issue 2 years ago โ€ข 6 comments

Description

This change brings code-coverage CI for supervision, allowing us to assess the extent of code coverage.

Code coverage is a metric that represents the percentage of your codebase that is executed when your tests run. It provides insight into how well your tests exercise your code and can be crucial in identifying untested parts of your application. A high code coverage percentage is often associated with a lower likelihood of bugs. However, it's essential to understand that code coverage doesn't guarantee the absence of defects. It merely indicates which parts of the code have been executed by the tests.

List any dependencies that are required for this change.

Type of change

Please delete options that are not relevant.

  • [X] New feature (non-breaking change which adds functionality)
  • [X] This change requires a documentation update

Any specific deployment considerations

We need to add codecov.io SECRET from website into this repo secret setting so we can see coverage reports

Docs

  • [X] Docs updated? What were the changes:

onuralpszr avatar Aug 13 '23 21:08 onuralpszr

Codecov Report

:exclamation: No coverage uploaded for pull request base (develop@6f427b9). Click here to learn what that means. Patch has no changes to coverable lines.

:exclamation: Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files
@@            Coverage Diff             @@
##             develop     #284   +/-   ##
==========================================
  Coverage           ?   46.88%           
==========================================
  Files              ?       26           
  Lines              ?     1892           
  Branches           ?        0           
==========================================
  Hits               ?      887           
  Misses             ?     1005           
  Partials           ?        0           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter avatar Aug 13 '23 21:08 codecov-commenter

@SkalskiP I already run codeconv in my own repo and here the results

https://app.codecov.io/gh/onuralpszr/supervision/tree/code-coverage/supervision

Example PR: https://github.com/onuralpszr/supervision/pull/1 (you can see the bot as well)

We have roboflow/supervision place : https://app.codecov.io/github/roboflow/supervision but for control we need to add "SECRETS".

onuralpszr avatar Aug 13 '23 21:08 onuralpszr

Hi @onuralpszr ๐Ÿ‘‹๐Ÿป I have already used Codecov in earlier projects. Let's add this. But rather in the form of information, because privately I think code coverage is a useless statistic. haha

How can I help?

SkalskiP avatar Aug 14 '23 09:08 SkalskiP

Hi @onuralpszr ๐Ÿ‘‹๐Ÿป I have already used Codecov in earlier projects. Let's add this. But rather in the form of information, because privately I think code coverage is a useless statistic. haha

How can I help?

Someone in admin perm needs to add SECRET and I already wrote in CI (secrets.CODECOV_TOKEN). that is all. I

am also curious why are you think like that. I rather want to talk to about it maybe you know something I do not know too.

onuralpszr avatar Aug 14 '23 09:08 onuralpszr

@onuralpszr problem is: I logged into codecov but the panel for roboflow/supervision looks completely different than for my other projects:

I usually see settings panel with CODECOV_TOKEN. But I don't see it for supervision.

SkalskiP avatar Aug 15 '23 11:08 SkalskiP

@onuralpszr problem is: I logged into codecov but the panel for roboflow/supervision looks completely different than for my other projects:

I usually see settings panel with CODECOV_TOKEN. But I don't see it for supervision.

Afaik we need organization permission for see setup button to add it

onuralpszr avatar Aug 15 '23 12:08 onuralpszr