Skip to content

feat: Deprecation Warning when Creating a Legacy Library#2563

Draft
kdmccormick wants to merge 2 commits intoopenedx:masterfrom
kdmccormick:kdmccormick/create-legacy-warning
Draft

feat: Deprecation Warning when Creating a Legacy Library#2563
kdmccormick wants to merge 2 commits intoopenedx:masterfrom
kdmccormick:kdmccormick/create-legacy-warning

Conversation

@kdmccormick
Copy link
Copy Markdown
Member

@kdmccormick kdmccormick commented Oct 23, 2025

Description

Adds this warning banner:

Screenshot 2025-10-22 at 1 37 07 PM

Supporting information

Part of: #2876

Merge considerations

  • Needs Product/UX review before merging

Testing instructions

N/A

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

  • Any new files are using TypeScript (.ts, .tsx).
  • Deprecated propTypes, defaultProps, and injectIntl patterns are not used in any new or modified code.
  • Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
  • Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
  • Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
  • All new i18n messages in messages.ts files have a description for translators to use.
  • Imports avoid using ../. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

@codecov
Copy link
Copy Markdown

codecov bot commented Oct 23, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.74%. Comparing base (106f22b) to head (935f2ec).
⚠️ Report is 147 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff            @@
##           master    #2563    +/-   ##
========================================
  Coverage   94.74%   94.74%            
========================================
  Files        1218     1218            
  Lines       27312    27313     +1     
  Branches     5988     6147   +159     
========================================
+ Hits        25878    25879     +1     
+ Misses       1376     1363    -13     
- Partials       58       71    +13     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jmakowski1123
Copy link
Copy Markdown

jmakowski1123 commented Oct 23, 2025

Thanks for the catch Kyle. I'm fine with the banner approach, given this is a temporary warning.

  1. I feel confident enough to say the "new" libraries will be out of Beta by Verawood. If we have similar confidence in the deprecation/migration timeline, we could specify Verawood instead of "future release". I don't see any red flags on that in terms of the migrations.
  2. Let's link to the new libraries Studio tab.

@kdmccormick kdmccormick added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Mar 16, 2026
@openedx openedx deleted a comment from open-craft-grove Mar 16, 2026
@rpenido
Copy link
Copy Markdown
Contributor

rpenido commented Mar 26, 2026

Hi @kdmccormick! I started working on #2876.
Do you want me to check the CI error here so this PR can be merged?
Thanks!

@kdmccormick
Copy link
Copy Markdown
Member Author

Yes please @rpenido !

We were also hoping that this warning would link to the V2 libraries interface, and wouldn't say "Libraries (Beta)".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

create-sandbox open-craft-grove should create a sandbox environment from this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants