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

Complete the bok-choy Deprecation #874

Closed
3 of 5 tasks
feanil opened this issue Sep 6, 2023 · 3 comments
Closed
3 of 5 tasks

Complete the bok-choy Deprecation #874

feanil opened this issue Sep 6, 2023 · 3 comments
Assignees

Comments

@feanil
Copy link
Contributor

feanil commented Sep 6, 2023

The bok-choy test framework has been deprecated for quite some time but we have not yet completed the removal. This ticket will track the remaining work left to complete the removal.

Note: Most of this is coming from openedx/public-engineering#13 (comment)

Tasks

  • Ensure that bok_choy settings files (both .py and .yml) are no longer used in edx-platform. In general, production.py and minimal.yml should be suitable replacements.
  • Go through the remaining repos that install bok-choy(listed below):
    • For each repo that installs bok-choy:
      • Is it deprecated?
        • Yes -> Great, just make a note of that one this issue, and move on.
        • No -> Does it actually use bok-choy?
          • Yes -> Open an issue for removing bok-choy, like this one.
          • No -> Open & merge a PR to remove bok-choy from the list of requirements.
  • Re-check to confirm that no other repos have added bok-choy as a dependency in the meantime.
  • Create an axim-engineering request to archive both the bok-choy and edx-custom-a11y-rules repo which is used exclusively as a bok-choy add-on.
  • Search for dangling references to bok-choy and remove them. For example, there are several obselete bok_choy settings files in edx-platform which can be removed.

Acceptance Criteria

  • edx-platform has no references of any sort to bok-choy
  • All other repos that use bok-choy have an issue indicating that they need to upgrade.
  • All teams that currently use bok-choy have been notified that bok-choy will be archived.
  • The bok-choy and custom-a11y-rules repo have both been archived.
@salman2013 salman2013 moved this from 🏗 In progress to 👀 In review in Aximprovements Team Oct 5, 2023
@salman2013 salman2013 moved this from 👀 In review to ✅ Done in Aximprovements Team Nov 3, 2023
@feanil feanil moved this from ✅ Done to 🏗 In progress in Aximprovements Team Nov 6, 2023
@feanil
Copy link
Contributor Author

feanil commented Nov 6, 2023

@salman2013 I re-opened this ticket because we still haven't archived the repo and I found a few more repos that are still mentioning bok-choy and should have related tickets: https://github.com/search?q=org%3Aopenedx+bok-choy+language%3AText&type=code&l=Text

Can you take a look and create tickets if needed and also make sure the two repos get archived before we close this ticket.

@salman2013 salman2013 moved this from 🏗 In progress to ✅ Done in Aximprovements Team Jan 30, 2024
@feanil
Copy link
Contributor Author

feanil commented Apr 18, 2024

The repo has been archived now.

@feanil feanil closed this as completed Apr 18, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done in Axim Engineering Tasks Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Archived in project
Development

No branches or pull requests

2 participants