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

Move to using cargo llvm-cov for coverage #228

Closed
2 tasks
alexdewar opened this issue Nov 15, 2024 · 0 comments · Fixed by #236
Closed
2 tasks

Move to using cargo llvm-cov for coverage #228

alexdewar opened this issue Nov 15, 2024 · 0 comments · Fixed by #236
Assignees
Labels
github_actions Pull requests that update GitHub Actions code

Comments

@alexdewar
Copy link
Collaborator

Currently, we're using tarpaulin to generate our test coverage. The problem is that it seems to falsely report lots of lines as not being covered (see upstream issue), which is not particularly helpful.

It seems that cargo-llvm-cov is a better, more modern alternative. I gave it a whirl and the coverage seemed to be much better. I won't give the full stats, but it gives about ~95% coverage overall cf. ~85% for tarpaulin (and fixes some of the false negatives I saw), so it seems that it's more reliable.

To do:

  • Change the cargo-build-and-test.yml CI workflow to generate coverage using cargo-llvm-cov cf. tarpaulin and upload it to codecov
  • Add a description on how to use it locally to the developer documentation
@github-project-automation github-project-automation bot moved this to 📋 Backlog in MUSE Nov 15, 2024
@alexdewar alexdewar moved this from 📋 Backlog to 🔖 Ready in MUSE Nov 15, 2024
@alexdewar alexdewar added the github_actions Pull requests that update GitHub Actions code label Nov 15, 2024
@alexdewar alexdewar self-assigned this Nov 18, 2024
@alexdewar alexdewar moved this from 🔖 Ready to 🏗 In progress in MUSE Nov 19, 2024
@alexdewar alexdewar moved this from 🏗 In progress to 👀 In review in MUSE Nov 19, 2024
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in MUSE Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github_actions Pull requests that update GitHub Actions code
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant