Skip to content

Remove the codecov badge, we're not using codecov anymore #1557

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Dec 20, 2021

Conversation

matthiask
Copy link
Member

Refs #1542

@matthiask matthiask requested a review from pauloxnet December 19, 2021 10:20
@matthiask matthiask force-pushed the remove-codecov-badge branch from dfee297 to 1b97fe1 Compare December 19, 2021 10:23
@pauloxnet
Copy link
Member

I think it would be better to replace the coverage badge with another one related to GitHub action instead of simply remove it.

@matthiask
Copy link
Member Author

I don't think that's easily possible without e.g. committing the resulting coverage to the repository.

Something like https://pypi.org/project/coverage-badge/ or https://shields.io/category/coverage could probably be used to generate the badge, but we'd need to store the percentage somewhere.

@pauloxnet
Copy link
Member

We have htmlcov in artifacts don't we already store the coverage percentage anywhere with GitHub Actions?

@tim-schilling
Copy link
Member

@tim-schilling
Copy link
Member

Never mind. I don't have access to the repo settings. Do you @matthiask?

@tim-schilling
Copy link
Member

We have htmlcov in artifacts don't we already store the coverage percentage anywhere with GitHub Actions?

Nope, the change uploads the report as an artifact, but I don't think the percentage isn't stored. I suppose we could use the failure threshold in the badge.

@tim-schilling
Copy link
Member

Welp I messed that up. I intended for it to be a suggestion not an actual commit.

@matthiask
Copy link
Member Author

Never mind. I don't have access to the repo settings. Do you @matthiask?

No. I think that's roadies-only territory.

@matthiask
Copy link
Member Author

I've been thinking about this for a bit. What purpose does showing the coverage in a badge serve? I don't think it's very useful. Code coverage is at best an approximation of the quality of a testsuite. It tests that the code doesn't crash right away, but that's basically all it proves. Correctness isn't required. So, it may be useful when writing new tests but I don't think it's a badge of honor to be worn proudly. I think we don't lose anything when we get rid of it.

@tim-schilling
Copy link
Member

I don't feel strongly one way or the other here. I'm content to remove it. Before we do though, here's a benefit of the coverage badge that you didn't explicitly mention. Having the coverage percentage listed on the README, along with a passing tests badge increases the project's trustworthiness for being well maintained. That can improve a developer's confidence that this project is something that can be integrated and will make them more likely to use it.

@pauloxnet
Copy link
Member

I agree with @tim-schilling and I approved the change.

@matthiask matthiask force-pushed the remove-codecov-badge branch from a777904 to 1b97fe1 Compare December 20, 2021 10:45
@matthiask
Copy link
Member Author

Re showing that the project is well maintained: Yes, that's a good point. I more often look at the timeline of recent commits and the CI jobs list to determine this, but the coverage may be telling.

@matthiask matthiask merged commit 03fdf3e into django-commons:main Dec 20, 2021
@matthiask matthiask deleted the remove-codecov-badge branch December 20, 2021 10:49
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants