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

Allow coverage reporting to be visible to PRs #293

Closed
wants to merge 0 commits into from

Conversation

youssef-itanii
Copy link
Contributor

Summary

The problem is that the coverage report is being displayed on the command line, and it would be ideal to have a GitHub formatted output that shows up in code files in the PR that highlights the lines of code that were not covered in the unit test CI workflow. Doing so, it would assist reviewers in ensuring that the code coverage is high.

The unit_tests workflow has been modified to:

  • Create a coverage file only if the specified OS and python version finish the test
  • Run a step to process the file and extract the file names and the missed lines/ranges and highlight the lines using workflow commands

Resolves: #288

Release Note

  • I modified pyproject.toml based on this PR, so this file might have to be deleted.

Documentation

@mihaimaruseac
Copy link
Collaborator

Nice! Thank you!

The needed PRs before this have been merged. Can you rebase, please?

Copy link
Collaborator

@mihaimaruseac mihaimaruseac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks nice. I have several suggestions

.github/workflows/unit_tests.yml Outdated Show resolved Hide resolved
.github/workflows/unit_tests.yml Outdated Show resolved Hide resolved
.github/workflows/unit_tests.yml Outdated Show resolved Hide resolved
.github/workflows/unit_tests.yml Outdated Show resolved Hide resolved
@mihaimaruseac
Copy link
Collaborator

Thank you!

@youssef-itanii
Copy link
Contributor Author

youssef-itanii commented Aug 19, 2024

there seems to be an issue where the lines of code are not being highlighted nor being echoed in the command line output after your checks ran. I'll look into this issue .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make coverage reporting be visible to the PR
2 participants