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

Added Codecov Workflow #22

Merged
merged 28 commits into from
Apr 11, 2024
Merged

Added Codecov Workflow #22

merged 28 commits into from
Apr 11, 2024

Conversation

UmairK5669
Copy link
Member

@UmairK5669 UmairK5669 commented Mar 14, 2024

Description:
Added a Codecov workflow that will allow pytest to perform any tests and upload the coverage to codecov using the pytest-cov dependency that has been added to pyproject.toml. This workflow will run on code that is pushed to the main branch as well as PRs that intend to merge into main.

Related Issues:
#12

Outstanding Sub-Issues:
This workflow simply uploads the test coverage to Codecov and doesn't check to see if it meets the threshold.

Tips for the Reviewer:
As there are no tests that Ria has presently, I would highly recommend adding dummy tests to test the workflow. After adding dummy tests run poetry run pytest to first ensure the tests are being ran, then push the code to this branch and the workflow will run automatically.

Checklist:
Please be sure to check all boxes honestly. This is to ensure a smooth development process, and to reduce the
likelihood of needing to make additional changes later on.

  • I understand that changes authored by individuals who have not signed a Contributor License Agreement (CLA),
    or whose authorship we cannot verify, may not be accepted.
  • These contribution address a triaged issue.
  • I have performed a self-review of my code and my changes generate no new warnings.
  • I have included unit tests for my code contributions, and all tests are passing.
  • The docstrings are complete, include doctests demonstrating usage, and are properly formatted.
    I have verified that any updates to the project documentation are complete and look okay.
  • I have confirmed all my code contributions are formatted in accordance with the project's Flake8 style
    configuration.
  • No unnecessary changes have been made to the Poetry lock file, but pyproject.toml and the Poetry lock file
    have been updated to reflect any dependency changes.
  • I acknowledge that upon the submission of this pull request, Qoherent will assume the copyright for this
    contribution.

A heartfelt thank you from everyone at Qoherent and the broader radio community for taking the time to contribute to
RIA Core. 🙏💖

@UmairK5669 UmairK5669 requested a review from fordg1 March 14, 2024 20:30
Copy link

codecov bot commented Mar 19, 2024

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

Copy link
Member Author

Choose a reason for hiding this comment

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

Should these dependencies be moved to the tool.poetry.group.test.dependencies?

@UmairK5669
Copy link
Member Author

UmairK5669 commented Mar 27, 2024

Looks good overall, I think let's remove the dummy tests so they don't reach the main branch.

@UmairK5669
Copy link
Member Author

Note: We will need to squash the commits at merge time.

@fordg1
Copy link
Collaborator

fordg1 commented Mar 27, 2024

Looks good overall, I think let's remove the dummy tests so they don't reach the main branch.

It looks like test_dummy.py is already in main, should we be removing it?

@UmairK5669
Copy link
Member Author

It looks like test_dummy.py is already in main, should we be removing it?

Yeah, I think they should, they don't really serve a purpose and were only for testing this workflow.

@UmairK5669 UmairK5669 merged commit 2b9eb21 into main Apr 11, 2024
2 of 3 checks passed
@UmairK5669 UmairK5669 deleted the codecov-workflow branch April 11, 2024 15:55
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.

2 participants