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

build: add system check to warn of pending devstack settings removal #34795

Merged

Conversation

kdmccormick
Copy link
Member

@kdmccormick kdmccormick commented May 14, 2024

Notes:

  • I had originally implemented this as a warnings.warn() call directly in lms/envs/devstack.py and cms/envs/devstack.py, but for whatever reason, those warnings were getting swallowed. System checks display more prominently, anyway.
  • The agreed removal date for these is "right after the Sumac cut". That could be Oct 9, Nov 9, or something in-between. My sense is that warning of an earlier date is better than warning of a later date, so this warning says that they will be removed "by October".
  • Part of: [DEPR] Devstack public-engineering#247

I tested this with edx/devstack. This is what devstack users will begin seeing in their console whenever any management command (including runserver) is executed:

image

Bonus commit: Remove some outdated config docs that reference BokChoy and the JSON config system.

Note: I had originally implemented this as a `warnings.warn()` call
directly in lms/envs/devstack.py and cms/envs/devstack.py, but for
whatever reason, those warnings were getting swallowed. System checks
display more prominently, anyway.

Part of: openedx/public-engineering#247
@kdmccormick kdmccormick force-pushed the kdmccormick/devstack-settings-warn branch from 268ad97 to 8baa739 Compare May 14, 2024 16:36
@kdmccormick kdmccormick requested a review from feanil May 14, 2024 16:37
@kdmccormick kdmccormick merged commit 7d7a18d into openedx:master May 15, 2024
48 checks passed
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

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.

3 participants