-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
build: swap default file storage away from deprecated lib #32646
Conversation
Thanks for the pull request, @stvstnfrd! Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. Once you've signed the CLA, please allow 1 business day for it to be processed. After this time, you can re-run the CLA check by editing the PR title. If the problem persists, you can tag the |
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.
It looks like the primary, related variables (AWS_ACCESS_KEY_ID
, AWS_SECRET_ASSESS_KEY
, etc.) remain the same in the new backend, but I'll do a deeper dive to confirm compatibility.
Note: This work is being done on behalf of OpenCraft and should, presumably, be covered under their CLA agreement. |
Looks good 👍 I haven't found a way to check if the Deprecation Warning is gone. @stvstnfrd Do you have any idea how to check it?
|
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 @ChrisChV . I couldn't find it generated anywhere either.
At face value, that configuration wouldn't be used unless one were setting AWS credentials, which presumably shouldn't happen during tests. I don't think the value is ever being tested/mocked elsewhere.
@ChrisChV, @stvstnfrd, I verified that this gets rid of these warnings in a production-like environment. I'll leave the +1 and merge once the CLA check is clear. |
@openedx/cla-problems I've tried re-running the CLA check, but since the runner provides no visual feedback or indicator, I can't tell if it's actually working or not. Related: Because the CLA check looks like it's been implemented with a webhook and not a Github Action, contributors can't manually rerun the check. If this were implemented with the latter, contributors could re-run the check explicitly, instead of relying on the "edit the title", which is a crude hack. Further, implementing this as a GHA would provide explicit, visual indication that the job was actually rerun (or not). |
@Agrendalath @ChrisChV Suggestions on who to ping from TCRIL about this? I tagged |
@mphilbrick211, could you re-run the CLA check? @tecoholic, is everything done on our end for the CLA? |
@stvstnfrd This upgrade is painless, with no required configuration changes. But ops people and @openedx/community-release-managers might wonder if there is, so could you add a link to the django-storages Migration docs in your PR description? That section of the docs has since been removed from the master docs, so it can be a little hard to find. |
Rebasing, as the CMS change was merged in #32733. |
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 tested this: tested the S3Boto3Storage in the production-like environment
- I read through the code
- I checked for accessibility issues: n/a
- Includes documentation: n/a
- I made sure any change in configuration variables is reflected in the corresponding client's
configuration-secure
repository: n/a
The S3BotoStorage backend was deprecated in favor of the S3Boto3Storage backend. This change updates the default backend to use the latter. style: This re-links and rewords a relevant comment that had been disconnected during previous refactoring. docs: https://github.com/jschneier/django-storages/blob/ade79308a3f20480bec8a964bdbf2f4e0b50ff43/docs/backends/amazon-S3.rst#migrating-from-boto-to-boto3 Fixes: FAL-3431 Fixes: public-engineering/128
@Agrendalath Rebased. @pomegranited Commit message amended to contain docs link. @ormsbee FYI since related to recent change you made. |
@Agrendalath Ready to merge. It's weird not having the Big Green Button myself 😜 |
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
2U Release Notice: This PR has been deployed to the edX production environment. |
1 similar comment
2U Release Notice: This PR has been deployed to the edX production environment. |
The S3BotoStorage backend was deprecated in favor of the S3Boto3Storage backend. This change updates the default backend to use the latter.
Style: This re-links a relevant comment that had been disconnected during a previous refactoring.
Note: There is a relevant configuration change forthcoming,
but it's docs/comments only.
Fixes: FAL-3431
Fixes: openedx/public-engineering#128