-
Notifications
You must be signed in to change notification settings - Fork 3
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
Fix test errors: codecov secret and missing package for docs #394
Conversation
To whoever reviews this PR, a question: why is there a list of requirements for |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #394 +/- ##
=======================================
Coverage 95.99% 95.99%
=======================================
Files 17 17
Lines 6113 6118 +5
=======================================
+ Hits 5868 5873 +5
Misses 245 245
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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.
Thanks @adeliegorce. To answer your question -- I agree it's redundant. I strongly prefer simply defining it in setup.cfg
(or better, pyproject.toml
!) so I would suggest removing the docs/requirements.txt
, but other people have different opinions. I like defining all the requirements in one place.
@@ -41,6 +41,8 @@ jobs: | |||
|
|||
- name: Upload coverage to Codecov | |||
uses: codecov/codecov-action@v3 |
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.
You should update this to v4
as well
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 tried v4 but there is an issue that prevents codecov from finding the coverage.xml file. It is a regression issue currently being looked at by the team codecov/codecov-action#1278
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.
So for now I stick with v3 :)
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 OK :-)
Hi @steven-murray, thanks for the review. I have made the requested changes apart from switching to |
This PR adds two elements that were missing for the tests to pass:
codecov
. Although it is not required for public repos, uploads often fail when you don't have one. If you don't set one, it uses like a backup public token which has a rate limit (@steven-murray)mock
package as a requirement for the documentation: buildingreadthedocs
is failing without (called inconf.py
)