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
Add a nox session for regenerating pinned requirements files used in CI #2664
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2664 +/- ##
==========================================
- Coverage 95.21% 94.88% -0.33%
==========================================
Files 103 103
Lines 9412 9412
Branches 2155 2155
==========================================
- Hits 8962 8931 -31
- Misses 273 299 +26
- Partials 177 182 +5 ☔ View full report in Codecov by Sentry. |
I ran into a problem when I was running
Will have to look into this later... |
📝 Some differences between nox and tox
|
noxfile.py
Outdated
requirements_directory = "ci_requirements" | ||
|
||
|
||
def get_requirements_file( |
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.
One of the benefits of switching to nox is that we can define functions to help create testing environments!
It turns out that this problem occurred on my workstation at work (running RHEL) but did not occur on my home computer (running Ubuntu 22.04). This PR is going to wait until after the 2024.5.0 release. |
# Temporarily use requirements files generated both by tox and nox | ||
# during the switchover from tox to nox. |
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.
Because the requirements filenames are changing, we'll need the files generated by tox for the remaining tox environments, as well as the files generated by nox for the current and forthcoming nox sessions. It'll be messier having duplicate requirements files under different names, but I want to switch things over completely soon.
Running `nox` will now make it print out a help message along with the list of sessions.
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.
👍
This PR adds a nox environment that can be used to regenerate requirements files. It can be run with
nox -s requirements
. The intention of this nox environment is to eventually replace the current tox environment, but the removal of the tox environment will come after sessions for running tests get added tonoxfile.py
...hopefully soon.This PR also standardizes the naming scheme for the requirements files, ideally making the names of the files better reflect what they are used for.
All of the files in
ci_requirements/
are auto-generated, so they probably be mostly skipped during the review.Only a couple pull requests into this, and I'm already hoping I never have to edit a
tox.ini
file ever again! 😹Related issues
#1734, #1735, #2647, #2654, #2656