Skip to content

chore: upgrade paragon to v23 in catalog-search #460

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

Closed

Conversation

huniafatima-99
Copy link

Merge checklist:

  • Evaluate how your changes will impact existing consumers (e.g., frontend-app-learner-portal-enterprise, frontend-app-admin-portal, and frontend-app-enterprise-public-catalog). Will consumers safely be able to upgrade to this change without any breaking changes?
  • Ensure your commit message follows the semantic-release conventional commit message format. If your changes include a breaking change, ensure your commit message is explicitly marked as a BREAKING CHANGE so the NPM package is released as such.
  • Once CI is passing, verify the package versions that Lerna will increment to in the Github Action CI workflow logs.
    • Note: This may be found in the "Preview Updated Versions (dry run)" step in the Github Action CI workflow logs.

Post merge:

  • Follow the release steps in the README documentation. Verify Lerna's release commit (e.g., chore(release): publish new versions) that incremented versions in relevant package.json and CHANGELOG files, and created Git tags for those versions is on master (Important: ensure the Git tags are for the correct commit SHA).
  • Run the Publish from package.json Github Action workflow to publish these new package versions to NPM.
    • This may be triggered by clicking the "Run workflow" option for the master branch.
  • Verify the new package versions were published to NPM (i.e., npm view <package_name> versions --json).
    • Note: There may be a slight delay between when the workflow finished and when NPM reports the package version as being published. If it doesn't appear right away in the above command, try again in a few minutes.

@adamstankiewicz
Copy link
Member

@huniafatima-99 Just a heads up, upgrading to Paragon v23 now is a bit early. There are several upstream dependencies that must ensure Paragon v23 support before this repo and its consuming MFEs can upgrade to v23. I'm wondering if you have a specific need for Paragon v23 now?

For additional context, Paragon v23 migrates from SCSS variables to CSS variables (via design tokens) and is a breaking change for consuming MFEs. In Open edX, MFEs are cutting master-design-tokens feature branches when upgrading to Paragon v23, not merging directly to master. On the 2U/edX.org side of things, our brand package @edx/brand-edx.org is no longer compatible with Paragon v23 with the intent to move to @edx/elm-theme, which is still not quite production-ready either.

@huniafatima-99
Copy link
Author

huniafatima-99 commented Apr 7, 2025

@huniafatima-99 Just a heads up, upgrading to Paragon v23 now is a bit early. There are several upstream dependencies that must ensure Paragon v23 support before this repo and its consuming MFEs can upgrade to v23. I'm wondering if you have a specific need for Paragon v23 now?

For additional context, Paragon v23 migrates from SCSS variables to CSS variables (via design tokens) and is a breaking change for consuming MFEs. In Open edX, MFEs are cutting master-design-tokens feature branches when upgrading to Paragon v23, not merging directly to master. On the 2U/edX.org side of things, our brand package @edx/brand-edx.org is no longer compatible with Paragon v23 with the intent to move to @edx/elm-theme, which is still not quite production-ready either.

Makes sense. Just a quick question, we should not update pragon to v23 for other MFEs as well. Is that correct or we can go ahead with other ones?
@adamstankiewicz

@huniafatima-99 huniafatima-99 marked this pull request as draft April 7, 2025 13:04
@adamstankiewicz
Copy link
Member

@huniafatima-99 For officially supported Open edX MFEs, Axim is working to cut the master-design-tokens feature branches such that they are all ready to merge into master by the Ulmo named Open edX release (December 2025).

Here is an epic issue tracking the migration to design tokens for official Open edX MFEs: openedx/platform-roadmap#393

2U/edX.org will not necessarily need to do the work ourselves to cut the master-design-tokens feature branches, etc. in these MFEs but we will be responsible for ensuring our private MFE build+deploy process is ready for Paragon v23 by Ulmo, in coordination with Open edX's timeframe.

2U's Aperture team is currently working to get the 2U/edX.org dependencies ready for Paragon v23 before then (e.g., @edx/elm-theme QA, @edx/frontend-component-header-edx, @edx/frontend-component-footer-edx, other issues like this, etc.).

MFEs not officially supported by Open edX (e.g., the Enterprise MFEs consuming the packages in this frontend-enterprise repository) or potentially forked into the edx GitHub org will be up to 2U/edX.org to tackle, though.

@huniafatima-99
Copy link
Author

@adamstankiewicz Thank you for the clarification. I believe I should leave updating paragon to v23 for this epic. For now I'll be closing this PR.

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.

2 participants