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

Publish HTML Unit Test Coverage Report #74

Open
kehoecj opened this issue Oct 18, 2023 · 4 comments
Open

Publish HTML Unit Test Coverage Report #74

kehoecj opened this issue Oct 18, 2023 · 4 comments
Labels
CI/CD CI/CD work including Github Actions help wanted Extra attention is needed

Comments

@kehoecj
Copy link
Contributor

kehoecj commented Oct 18, 2023

Go's coverage tool can export the coverage results into an HTML report. It would be really beneficial for the maintainers to be able to see the HTML coverage report as part of a PR to ensure that all critical code is getting coverage. It would also be nice to link the coverage badge to the coverage report generated by the main branch to drill down into the current coverage.

@kehoecj kehoecj added help wanted Extra attention is needed CI/CD CI/CD work including Github Actions hacktoberfest-accepted Valid PR Hacktoberfest PR hacktoberfest Hacktoberfest 2023 labels Oct 18, 2023
@u5surf
Copy link
Contributor

u5surf commented Oct 20, 2023

@kehoecj
Hi, I'm interesting in this issue.
Can you use the third party services such as codecov or coveralls?
Because I consider that they are more friendly and user experience than a home made html coverage site.

https://coveralls.io/
https://about.codecov.io/

@kehoecj
Copy link
Contributor Author

kehoecj commented Oct 20, 2023

@u5surf It's yours if you'd like it! We're not able to use 3rd party services at this time. We can use whatever is available in Github itself though. I have a PR out that should get merged today that implements local coverage badges for that reason. You might want to wait on that to get merged to get started since it's already handling the coverage report generation. I was thinking we might be able to use Github pages but we already use that for our splash page. I don't know if you can host different sites for different branches.

@u5surf
Copy link
Contributor

u5surf commented Oct 21, 2023

@kehoecj

We're not able to use 3rd party services at this time.

Why can't you choose to use these services?
It is no risk to publish some sensitive data because it is the OSS production which has already exposed the code on publish. Even if you concerned about the security risk e.g we expose unconsiously somewhat password or credentials, we have better to be protected another processes.
Moreover these services are generally free to use in OSS product.
I mean that it's quite defacto standerd in OSS to use these SaaS products instead you make and operate the coverage site yourself.
Of course, we can make it ourselves, but generally it is not better choice to spend much costs to maintain its coverage site which is different from the essentials of the OSS product.

https://medium.com/@jonjo89/tutorial-getting-started-with-code-coverage-on-your-github-repositories-fd6b1fc7579d#:~:text=1.-,What%20is%20code%20coverage%3F,is%20run%20by%20the%20tests.

@kehoecj
Copy link
Contributor Author

kehoecj commented Oct 23, 2023

@kehoecj

We're not able to use 3rd party services at this time.

Why can't you choose to use these services? It is no risk to publish some sensitive data because it is the OSS production which has already exposed the code on publish. Even if you concerned about the security risk e.g we expose unconsiously somewhat password or credentials, we have better to be protected another processes. Moreover these services are generally free to use in OSS product. I mean that it's quite defacto standerd in OSS to use these SaaS products instead you make and operate the coverage site yourself. Of course, we can make it ourselves, but generally it is not better choice to spend much costs to maintain its coverage site which is different from the essentials of the OSS product.

https://medium.com/@jonjo89/tutorial-getting-started-with-code-coverage-on-your-github-repositories-fd6b1fc7579d#:~:text=1.-,What%20is%20code%20coverage%3F,is%20run%20by%20the%20tests.

I totally hear what you're saying but integration with third-party services needs to be approved by Boeing. Each SaSS service can have different terms and conditions that differ between organizations vs individual OSS projects. I have put in a request to have integration with 3rd party services reviewed and it's working it way through our processes. I don't know how long it will take and given that this project has become more active I wanted to put in place a temporary solution.

@kehoecj kehoecj removed hacktoberfest-accepted Valid PR Hacktoberfest PR hacktoberfest Hacktoberfest 2023 labels Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD CI/CD work including Github Actions help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants