-
Notifications
You must be signed in to change notification settings - Fork 24
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
Introduce Ruff linter/formatter and test runner with coverage report #26
Introduce Ruff linter/formatter and test runner with coverage report #26
Conversation
…ure/introduce-ruff-and-test-runner
@ryansurf ![]() I added MishaKav/pytest-coverage-comment#68 It seems that the repository owner needs to change the branch protection settings according to the above link. Could you please handle this? |
@ryansurf Therefore, I specified When you, as the owner, submit a PR, the coverage report should be generated without any issues, so please use this for future development :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Haven't seen a makefile in ages 😳
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I decided to use Make because it comes pre-installed on Linux systems and can function as a simple task runner.
In addition to Makefiles, there are several other well-known task runner tools. For Python, I've used tools like Taskipy
before.
https://github.com/taskipy/taskipy
However, I think Make isn't installed by default on Windows systems, so if you think it's better to switch to a Python-based task runner, that's totally fine with me!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, make is fine with me. I was more saying that because I haven't worked with C/C++ in ages and that makefile reminded me of pain🤣
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Haha, I totally get it now 😂
Awww yeahh, solid work. So from what I understand, to generate the coverage report as a comment on a PR I'll start developing in branches, submit a PR and then we'll see the pytest coverage report? It would be cool to have this done on all PRs, but I suppose it makes sense that it cant 😔 You work very fast, thank you for the PR! Edit: I see how it works now, whenever I merge a PR is generates the report. Seems like its working perfectly |
@ryansurf
This pull request introduces Ruff as a linter/formatter tool and sets up a test runner with coverage reporting.
The following changes have been made:
make lint
) and formatter (make format
).make test
) and generate a coverage report (make post_test
).pytest.yml
) has been updated to run tests and post the coverage report as a comment on pull requests.The addition of the
dev-requirements.txt
file makes it easier for developers to set up the necessary development dependencies by runningpip install -r dev-requirements.txt
.Please review!!