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

feat(CI/CD):Implement Code cov for local system using makefile #1622

Open
Tracked by #1587
lsampras opened this issue Jul 5, 2023 · 1 comment
Open
Tracked by #1587

feat(CI/CD):Implement Code cov for local system using makefile #1622

lsampras opened this issue Jul 5, 2023 · 1 comment
Labels
A-CI-CD Area: Continuous Integration/Deployment A-disputes Area: Dispute flows good first issue Good for newcomers help wanted Extra attention is needed

Comments

@lsampras
Copy link
Member

lsampras commented Jul 5, 2023

Context
As any other codebase, unit tests are vital to maintain stability & correctness of code..
Currently while the project has some amount of tests, We still don't have a code coverage tracking in place which robs people of some of the incentives for adding tests.
We should aim to add code coverage checks on PR's to add the necessary incentives in place

Objectives
We need unit test runs + code coverage summaries on PR's to get an idea about the diff in code coverage caused by the PR...

For local development people often have their own ways to run & test code locally...
However we would also like to provide a standardized approach via Makefile that has to be consistent with the report generated via CI...

locally we prefer to have an lcov based diff generated due to integrations with vscode etc..

Any temporary files generated due to code coverage locally shouldn't be tracked & should be auto-ignored via the .gitignore file (you can update the .gitignore file to do so)

Cargo tests supports code coverage via builtin cargo test.
Our objective is to generate reports via lcov.

@lsampras lsampras added A-CI-CD Area: Continuous Integration/Deployment good first issue Good for newcomers help wanted Extra attention is needed A-disputes Area: Dispute flows labels Jul 5, 2023
@Karandeep09
Copy link

Hey @lsampras, I would like to pick this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-CI-CD Area: Continuous Integration/Deployment A-disputes Area: Dispute flows good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants